sp_help (Transact-SQL)

Syntax

sp_help [ [ @objname = ] 'name' ]

Argumente

• [ @objname=] 'name'
  Der Name eines beliebigen Objekts in der sysobjects-Tabelle oder eines beliebigen benutzerdefinierten Datentyps in der systypes-Tabelle. name ist vom Datentyp nvarchar(776) und hat den Standardwert NULL. Datenbanknamen sind nicht zulässig.

Rückgabecodewerte

0 (Erfolg) oder 1 (Fehler)

Resultsets

Die zurückgegebenen Resultsets hängen davon ab, ob und wann name angegeben wird und um welches Datenbankobjekt es sich dabei handelt.

1. Wenn Sie sp_help ohne Argumente ausführen, wird eine Zusammenfassung aller Objekttypen zurückgegeben, die in der aktuellen Datenbank vorhanden sind.

   Spaltenname	Datentyp	Beschreibung
   Name	nvarchar(128)	Objektname
   Owner	nvarchar(128)	Objektbesitzer
   Object_type	nvarchar(31)	Objekttyp

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

   Spaltenname	Datentyp	Beschreibung
   Type_name	nvarchar(128)	Name des Datentyps
   Storage_type	nvarchar(128)	Name des SQL Server-Typs
   Length	smallint	Physische Länge des Datentyps (in Bytes)
   Prec	int	Genauigkeit (Gesamtzahl der Ziffern)
   Scale	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.
   Collation	sysname	Sortierung des Datentyps. NULL für Nicht-Zeichen-Datentypen

3. Wenn name ein beliebiges Datenbankobjekt ist (außer einem Datentyp), gibt sp_help das folgende Resultset und zusätzliche Resultsets basierend auf dem angegebenen Objekttyp zurück.

   Spaltenname	Datentyp	Beschreibung
   Name	nvarchar(128)	Tabellenname
   Owner	nvarchar(128)	Tabellenbesitzer
   Type	nvarchar(31)	Tabellentyp
   Created_datetime	datetime	Erstellungsdatum der Tabelle

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

   Wenn name eine Systemtabelle, eine Benutzertabelle oder eine 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
     Type	nvarchar(128)	Datentyp der Spalte
     Computed	varchar(35)	Zeigt an, ob die Werte in der Spalte berechnet werden: Yes oder No.
     Length	int	Spaltenlänge in Bytes Hinweis Wenn der Datentyp der Spalte ein Typ mit großem Wert ist (varchar(max), nvarchar(max), varbinary(max) oder xml), wird der Wert als -1 angezeigt.
     Prec	char(5)	Spaltengenauigkeit
     Scale	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
     Collation	sysname	Sortierung der Spalte. NULL für Nicht-Zeichen-Datentypen.

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

     Spaltenname	Datentyp	Beschreibung
     Identity	nvarchar(128)	Name der Spalte, deren Datentyp als Identität deklariert wird
     Seed	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 wie 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 Indexes
     index_keys	nvarchar(2078)	Namen der Spalten, die für den Index verwendet werden

   • 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 (keine Aktion), CASCADE (Kaskadieren) oder N/A (N/V). Gilt nur für FOREIGN KEY-Einschränkungen.
     update_action	nvarchar(9)	Zeigt den Wert der UPDATE-Aktion an: No Action (keine Aktion), Cascade (Kaskadieren) oder N/A (N/V). 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
     Type	nvarchar(128)	Datentyp des Parameters der gespeicherten Prozedur
     Length	smallint	Maximale physische Speicherlänge in Bytes
     Prec	int	Genauigkeit oder Gesamtzahl der Ziffern
     Scale	int	Die Anzahl der Ziffern rechts vom Dezimalzeichen
     Param_order	smallint	Reihenfolge der Parameter

Hinweise

sp_help sucht nur in der aktuellen Datenbank nach einem Objekt.

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

sp_help macht nur Indexspalten, die geordnet werden können, verfügbar; daher werden keine Informationen über XML-Indizes oder räumliche Indizes bereitgestellt.

Berechtigungen

Erfordert die Mitgliedschaft in der public-Rolle. Der Benutzer muss mindestens über eine Berechtigung für objname verfügen. Zum Anzeigen von Schlüsseln, Standardwerten oder Regeln für Spalteneinschränkungen müssen Sie über die VIEW DEFINITION-Berechtigung für die Tabelle verfügen.

Beispiele

A. Zurückgeben von Informationen zu allen Objekten

USE master;
GO
EXEC sp_help;
GO

B. Zurückgeben von Informationen zu einem einzelnen Objekt

USE AdventureWorks;
GO
EXEC sp_help 'Person.Contact';
GO

Siehe auch

Verweis