sp_help (Transact-SQL)
Fournit des informations sur un objet de base de données (tout objet répertorié dans la vue de compatibilité sys.sysobjects), un type de données défini par l'utilisateur ou un type de données.
.gif "Icône Lien de rubrique")
Conventions de la syntaxe Transact-SQL
Syntaxe
sp_help [ [ @objname = ] 'name' ]
Arguments
- [ @objname=] 'name'
Nom de n'importe quel objet dans sysobjects ou de n'importe quel type de données défini par l'utilisateur dans la table systypes. name est de type nvarchar(776), avec NULL comme valeur par défaut. Vous ne pouvez pas spécifier un nom de base de données.
Valeurs des codes de retour
0 (succès) ou 1 (échec)
Jeux de résultats
La spécification ou non spécification de name, le moment auquel cette option est spécifiée et l'objet de base de données qu'elle représente déterminent les jeux de résultats retournés.
Si sp_help est exécuté sans arguments, des informations résumées concernant tous les types d'objets existant dans la base de données en cours sont retournées.
Nom de colonne
Type de données
Description
Nom
nvarchar(128)
Nom de l'objet
Propriétaire
nvarchar(128)
Propriétaire de l'objet
Object_type
nvarchar(31)
Type d'objet
Si name est un type de données défini par l'utilisateur ou spécifique à SQL Server, la procédure sp_help retourne ce jeu de résultats.
Nom de colonne
Type de données
Description
Type_name
nvarchar(128)
Nom du type de données
Storage_type
nvarchar(128)
Nom de type SQL Server.
Longueur
smallint
Longueur physique du type de données (en octets).
Prec
int
Précision (nombre total de chiffres).
Scale
int
Nombre de chiffres situés à droite du séparateur décimal.
Nullable
varchar(35)
Indique si les valeurs NULL sont autorisées : Oui ou Non.
Default_name
nvarchar(128)
Nom par défaut de ce type de données.
NULL = aucune valeur par défaut n'est liée.
Rule_name
nvarchar(128)
Nom d'une règle associée à ce type.
NULL = aucune valeur par défaut n'est liée.
Collation
sysname
Classement du type de données. NULL pour les types de données non caractère.
Si name est un objet de base de données autre qu'un type de données, la procédure sp_help retourne ce jeu de résultats, ainsi que des jeux de résultats supplémentaires, en se basant sur le type d'objet indiqué.
Nom de colonne
Type de données
Description
Nom
nvarchar(128)
Nom de la table
Propriétaire
nvarchar(128)
Propriétaire de la table
Type
nvarchar(31)
Type de la table
Created_datetime
datetime
Date de création de la table
Selon l'objet de base de données spécifié, sp_help retourne des jeux de résultats supplémentaires.
Si name est une table système, une table utilisateur ou une vue, la procédure sp_help retourne les jeux de résultats suivants. Toutefois, le jeu de résultats qui indique à quel endroit se trouve le fichier de données sur un groupe de fichiers n'est pas retourné pour une vue.
Jeu de résultats supplémentaire retourné sur des objets de colonne :
Nom de colonne
Type de données
Description
Column_name
nvarchar(128)
Nom de colonne.
Type
nvarchar(128)
Type de données de la colonne.
Calculée
varchar(35)
Indique si les valeurs de la colonne sont calculées : Oui ou Non.
Length
int
Longueur de la colonne en octets.
.gif "Remarque")
Remarque
Si les données de la colonne sont de type à valeur élevée (varchar(max), nvarchar(max), varbinary(max) ou xml), la valeur -1 sera affichée.Prec
char(5)
Précision de la colonne
Scale
char(5)
Échelle de la colonne
Nullable
varchar(35)
Indique si les valeurs NULL sont autorisées dans cette colonne : Oui ou Non.
TrimTrailingBlanks
varchar(35)
Élimine les vides. Retourne Oui ou Non.
FixedLenNullInSource
varchar(35)
Uniquement pour la compatibilité descendante.
Collation
sysname
Classement de la colonne. NULL pour les types de données non caractères.
Jeu de résultats supplémentaire retourné sur des colonnes d'identité :
Nom de colonne
Type de données
Description
Identity
nvarchar(128)
Nom de la colonne dont le type de données déclaré est identité.
Seed
numeric
Valeur de départ de la colonne identité.
Increment
numeric
Incrément à appliquer aux valeurs de la colonne.
Not For Replication
int
La propriété IDENTITY ne doit pas être activée lorsqu'une connexion de réplication, comme sqlrepl, insère des données dans la table.
1 = Vrai
0 = Faux
Jeu de résultats supplémentaire retourné sur des colonnes :
Nom de colonne
Type de données
Description
RowGuidCol
sysname
Nom de la colonne d'identification unique.
Jeu de résultats supplémentaire retourné sur des groupes de fichiers :
Nom de colonne
Type de données
Description
Data_located_on_filegroup
nvarchar(128)
Groupe de fichiers dans lequel se trouvent les données : primaire, secondaire ou journal des transactions.
Jeu de résultats supplémentaire retourné sur les index :
Nom de colonne
Type de données
Description
index_name
sysname
Nom de l'index.
Index_description
varchar(210)
Description de l'index.
index_keys
nvarchar(2078)
Noms des colonnes servant de base à l'index. Retourne la valeur NULL pour les index columnstore.
Jeu de résultats supplémentaire retourné sur des contraintes :
Nom de la colonne
Type de données
Description
constraint_type
nvarchar(146)
Type de contrainte.
constraint_name
nvarchar(128)
Nom de la contrainte.
delete_action
nvarchar(9)
Indique si l'action DELETE est : NO_ACTION, CASCADE, SET_NULL, SET_DEFAULT ou N/A.
Uniquement applicable aux contraintes FOREIGN KEY.
update_action
nvarchar(9)
Indique si l'action UPDATE est : NO_ACTION, CASCADE, SET_NULL, SET_DEFAULT ou N/A.
Uniquement applicable aux contraintes FOREIGN KEY.
status_enabled
varchar(8)
Indique si la contrainte est activée : Enabled, Disabled ou N/A.
Uniquement applicable aux contraintes CHECK et FOREIGN KEY.
status_for_replication
varchar(19)
Indique si la contrainte concerne la réplication.
Uniquement applicable aux contraintes CHECK et FOREIGN KEY.
constraint_keys
nvarchar(2078)
Nom des colonnes qui constituent la contrainte ou, pour les valeurs par défaut ou les règles, le texte qui définit la valeur par défaut ou la règle.
Jeu de résultats supplémentaire retourné sur des objets de référence :
Nom de colonne
Type de données
Description
Table is referenced by
nvarchar(516)
Identifie les autres objets de base de données qui font référence à la table.
Jeu de résultats supplémentaire retourné sur les procédures stockées, les fonctions ou les procédures stockées étendues.
Nom de colonne
Type de données
Description
Parameter_name
nvarchar(128)
Nom du paramètre de la procédure stockée.
Type
nvarchar(128)
Type de données du paramètre de la procédure stockée.
Length
smallint
Longueur maximale de stockage physique, en octets.
Prec
int
Précision ou nombre total de chiffres.
Scale
int
Nombre de chiffres situés à droite du séparateur décimal.
Param_order
smallint
Ordre du paramètre.
Notes
La procédure sp_help ne recherche un objet que dans la base de données active.
Lorsque la valeur de name n'est pas spécifiée, la procédure sp_help répertorie les noms, les propriétaires et les types de tous les objets de la base de données active. sp_helptrigger fournit des informations sur les déclencheurs.
La procédure sp_help expose uniquement les colonnes d'index pouvant être ordonnées ; par conséquent, elle n'expose pas d'informations sur les index XML ou les index spatiaux.
Autorisations
Nécessite l'appartenance au rôle public. L'utilisateur doit avoir au moins une autorisation sur objname. Pour consulter des clés de contrainte, des valeurs par défaut ou des règles de colonne, vous devez disposer de l'autorisation VIEW DEFINITION sur la table.
Exemples
A.Retour d'informations sur tous les objets
L'exemple suivant fournit des informations sur chaque objet de la base de données master.
USE master;
GO
EXEC sp_help;
GO
B.Retour d'informations sur un objet unique
L'exemple suivant affiche des informations sur la table Person.
USE AdventureWorks2012;
GO
EXEC sp_help 'Person.Person';
GO
Voir aussi
Référence
Procédures stockées du moteur de base de données (Transact-SQL)