sp_help (Transact-SQL)

  • Artikel

Gilt für:SQL ServerAzure SQL-DatenbankAzure SQL Managed Instance

Gibt Informationen zu einem Datenbankobjekt (jedes in der sys.sysobjects-Kompatibilitätsansicht aufgeführte Objekt), zu einem benutzerdefinierten Datentyp oder zu einem Datentyp.

Transact-SQL-Syntaxkonventionen

Syntax

  
sp_help [ [ @objname = ] 'name' ]

Argumente

[ @objname = ] 'name' Der Name eines beliebigen Objekts in sysobjects oder eines beliebigen benutzerdefinierten Datentyps in der systypes-Tabelle . name ist nvarchar(776) mit dem Standardwert NULL. Datenbanknamen sind nicht zulässig. Zwei oder drei Teilenamen können getrennt sein, z. B. "Person.AddressType" oder "[Person]. [AddressType]".

Rückgabecodewerte

„0“ (erfolgreich) oder „1“ (fehlerhaft)

Resultsets

Die zurückgegebenen Resultsets hängen davon ab, ob der Name angegeben wird, wann er angegeben wird und welches Datenbankobjekt es ist.

  1. Wenn sp_help ohne Argumente ausgeführt wird, werden Zusammenfassungsinformationen von Objekten aller Typen zurückgegeben, die in der aktuellen Datenbank vorhanden sind.

    Spaltenname Datentyp BESCHREIBUNG
    Name nvarchar(128) Objektname
    Besitzer nvarchar(128) Objektbesitzer (Dies ist der Datenbankprinzipal, der das Objekt besitzt. Standardmäßig wird der Besitzer des Schemas verwendet, das das -Objekt enthält.)
    Object_type nvarchar(31) Objekttyp

  2. Wenn name ein SQL Server Datentyp oder benutzerdefinierter Datentyp ist, gibt sp_help dieses Resultset zurück.

    Spaltenname Datentyp BESCHREIBUNG
    Type_name nvarchar(128) Name des Datentyps.
    Storage_type nvarchar(128) SQL Server Typname.
    Länge smallint Physische Länge des Datentyps (in Bytes)
    Prec int Genauigkeit (Gesamtzahl der Ziffern)
    Scale (Skalieren) int Anzahl der Stellen nach dem Dezimaltrennzeichen
    NULL zulassen varchar(35) Zeigt an, ob NULL-Werte zulässig sind: Yes oder No.
    Default_name nvarchar(128) Name eines an diesen Typ gebundenen Standards.

    NULL = Es ist kein Standard gebunden.
    Rule_name nvarchar(128) Name einer an diesen Typ gebundenen Regel.

    NULL = Es ist kein Standard gebunden.
    Sortierung sysname Sortierung des Datentyps. NULL für Nicht-Zeichen-Datentypen

  3. Wenn name ein anderes Datenbankobjekt als ein Datentyp ist, gibt sp_help dieses Resultset und zusätzliche Resultsets basierend auf dem typ des angegebenen Objekts zurück.

    Spaltenname Datentyp BESCHREIBUNG
    Name nvarchar(128) Tabellenname
    Besitzer nvarchar(128) Tabellenbesitzer
    Typ nvarchar(31) Tabellentyp
    Created_datetime datetime Erstellungsdatum der Tabelle

    Abhängig vom angegebenen Datenbankobjekt gibt sp_help zusätzliche Resultsets zurück.

    Wenn name eine Systemtabelle, Benutzertabelle oder Sicht ist, gibt sp_help die folgenden Resultsets zurück. Das Resultset, das beschreibt, wo sich die Datendateien in einer Dateigruppe befinden, wird jedoch nicht für eine Sicht zurückgegeben.

    • Zusätzliches Resultset, das für Spaltenobjekte zurückgegeben wird:

      Spaltenname Datentyp BESCHREIBUNG
      Column_name nvarchar(128) Spaltenname.
      Typ nvarchar(128) Spaltendatentyp.
      Berechnete varchar(35) Zeigt an, ob die Werte in der Spalte berechnet werden: Yes oder No.
      Länge int Spaltenlänge in Bytes

      Hinweis: Wenn der Spaltendatentyp ein großer Werttyp (varchar(max), nvarchar(max), varbinary(max)oder xml ist, wird der Wert als -1 angezeigt.
      Prec char(5) Spaltengenauigkeit
      Scale (Skalieren) char(5) Dezimalstellen einer Spalte
      NULL zulassen varchar(35) Zeigt an, ob in der Spalte NULL-Werte zulässig sind: Yes oder No.
      TrimTrailingBlanks varchar(35) Nachfolgende Leerzeichen entfernen. Gibt Yes oder No zurück.
      FixedLenNullInSource varchar(35) Nur aus Gründen der Abwärtskompatibilität beibehalten
      Sortierung sysname Sortierung der Spalte. NULL für Nicht-Zeichen-Datentypen.

    • Zusätzliches Resultset, das für Identitätsspalten zurückgegeben wird:

      Spaltenname Datentyp Beschreibung
      Identität nvarchar(128) Name der Spalte, deren Datentyp als Identität deklariert wird
      Samen numeric Startwert für die Identitätsspalte
      Increment numeric Schrittweite für Werte in dieser Spalte
      Not For Replication int DIE IDENTITY-Eigenschaft wird nicht erzwungen, wenn eine Replikationsanmeldung, z. B. sqlrepl, Daten in die Tabelle einfügt:

      1 = True

      0 = False

    • Zusätzliches Resultset, das für Spalten zurückgegeben wird:

      Spaltenname Datentyp BESCHREIBUNG
      Rowguidcol sysname Name der GUID-Spalte

    • Zusätzliches Resultset, das für Dateigruppen zurückgegeben wird:

      Spaltenname Datentyp BESCHREIBUNG
      Data_located_on_filegroup nvarchar(128) Die Dateigruppe, in der sich die Daten befinden: primäre oder sekundäre Dateigruppe oder Transaktionsprotokoll

    • Zusätzliches Resultset, das für Indizes zurückgegeben wird:

      Spaltenname Datentyp BESCHREIBUNG
      index_name sysname Indexname.
      Index_description varchar(210) Beschreibung des Index.
      index_keys nvarchar(2078) Namen der Spalten, die für den Index verwendet werden. Gibt für speicheroptimierte xVelocity-columnstore-Indizes NULL zurück.

    • Zusätzliches Resultset, das für Einschränkungen zurückgegeben wird:

      Spaltenname Datentyp BESCHREIBUNG
      constraint_type nvarchar(146) Einschränkungstyp
      constraint_name nvarchar(128) Name der Einschränkung
      delete_action nvarchar(9) Zeigt den Wert der DELETE-Aktion an: NO_ACTION, CASCADE, SET_NULL, SET_DEFAULT oder N/A.

      Gilt nur für FOREIGN KEY-Einschränkungen.
      update_action nvarchar(9) Zeigt den Wert der UPDATE-Aktion an: NO_ACTION, CASCADE, SET_NULL, SET_DEFAULT oder N/A.

      Gilt nur für FOREIGN KEY-Einschränkungen.
      status_enabled varchar(8) Zeigt an, ob die Einschränkung aktiviert ist: Enabled (aktiviert), Disabled (deaktiviert) oder N/A (NV).

      Gilt nur für CHECK- und FOREIGN KEY-Einschränkungen.
      status_for_replication varchar(19) Zeigt an, ob die Einschränkung für die Replikation gilt.

      Gilt nur für CHECK- und FOREIGN KEY-Einschränkungen.
      constraint_keys nvarchar(2078) Die Namen der Spalten für die Einschränkung oder bei Standards und Regeln der Text, der den Standard oder die Regel definiert.

    • Zusätzliches Resultset, das für verweisende Objekte zurückgegeben wird:

      Spaltenname Datentyp BESCHREIBUNG
      Table is referenced by nvarchar(516) Identifiziert andere Datenbankobjekte, die auf die Tabelle verweisen.

    • Zusätzliches Resultset, das für gespeicherte Prozeduren, Funktionen oder erweiterte gespeicherte Prozeduren zurückgegeben wird.

      Spaltenname Datentyp BESCHREIBUNG
      Parameter_name nvarchar(128) Name des Parameters der gespeicherten Prozedur
      Typ nvarchar(128) Datentyp des Parameters der gespeicherten Prozedur
      Länge smallint Maximale physische Speicherlänge in Bytes
      Prec int Genauigkeit oder Gesamtzahl der Ziffern
      Scale (Skalieren) int Die Anzahl der Ziffern rechts vom Dezimalzeichen
      Param_order smallint Reihenfolge der Parameter

Bemerkungen

Die sp_help Prozedur sucht nur nach einem Objekt in der aktuellen Datenbank.

Wenn name nicht angegeben ist, listet sp_help Objektnamen, Besitzer und Objekttypen für alle Objekte in der aktuellen Datenbank auf. sp_helptrigger stellt Informationen zu Triggern bereit.

sp_help macht nur geordnete Indexspalten verfügbar. daher werden keine Informationen zu XML-Indizes oder räumlichen Indizes verfügbar gemacht.

Berechtigungen

Erfordert die Mitgliedschaft in der public -Rolle. Der Benutzer muss über mindestens eine Berechtigung für objname verfügen. Um Spalteneinschränkungsschlüssel, Standards oder Regeln anzuzeigen, müssen Sie über die VIEW DEFINITION-Berechtigung für die Tabelle verfügen.

Beispiele

A. Zurückgeben von Informationen zu allen Objekten

Das folgende Beispiel führt Informationen zu jedem Objekt in der master-Datenbank auf.

USE master;  
GO  
EXEC sp_help;  
GO

B. Zurückgeben von Informationen zu einem einzelnen Objekt

Das folgende Beispiel zeigt Informationen zur Person-Tabelle an.

USE AdventureWorks2022;  
GO  
EXEC sp_help 'Person.Person';  
GO

Weitere Informationen

Gespeicherte Prozeduren für die Datenbank-Engine (Transact-SQL)
sp_helpindex (Transact-SQL)
sp_helprotect (Transact-SQL)
sp_helpserver (Transact-SQL)
sp_helptrigger (Transact-SQL)
sp_helpuser (Transact-SQL)
Gespeicherte Systemprozeduren (Transact-SQL)
sys.sysobjects (Transact-SQL)