Partager via

sp_help (Transact-SQL)

  • Article

S’applique à : SQL Server Azure SQL Database Azure SQL Managed Instance

Signale des informations sur un objet de base de données (n’importe quel objet répertorié dans la sys.sysobjects vue de compatibilité), un type de données défini par l’utilisateur ou un type de données.

Conventions de la syntaxe Transact-SQL

Syntaxe

sp_help [ [ @objname = ] N'objname' ]
[ ; ]

Arguments

[ @objname = ] N’objname'

Nom de n’importe quel objet, dans sys.sysobjects ou n’importe quel type de données défini par l’utilisateur dans la sys.systypes table. @objname est nvarchar(776), avec la valeur par défaut NULL. Les noms de base de données ne sont pas acceptables. Deux ou trois noms de parties peuvent être délimités, tels que Person.AddressType ou [Person].[AddressType].

Valeurs des codes de retour

0 (réussite) or 1 (échec).

Jeu de résultats

Les jeux de résultats retournés dépendent du fait que @name est spécifié, lorsqu’il est spécifié et quel objet de base de données il s’agit.

  1. Si sp_help elle est exécutée sans argument, les informations récapitulatives des objets de tous les types qui existent dans la base de données active sont retournées.

    Nom de la colonne Type de données Description
    Name nvarchar(128) Object name
    Owner nvarchar(128) Propriétaire de l’objet (principal de base de données propriétaire de l’objet. La valeur par défaut est le propriétaire du schéma qui contient l’objet.)
    Object_type nvarchar(31) Type d’objet

  2. Si @name est un type de données SQL Server ou un type de données défini par l’utilisateur, sp_help retourne ce jeu de résultats.

    Nom de la colonne Type de données Description
    Type_name nvarchar(128) Nom du type de données.
    Storage_type nvarchar(128) Nom du serveur SQL Server.
    Length smallint Longueur physique du type de données (en octets).
    Prec int Précision (nombre total de chiffres).
    Scale int Nombre de chiffres à droite de la décimale.
    Nullable varchar(35) Indique si NULL les valeurs sont autorisées : Yes ou No.
    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 autres que des caractères.

  3. Si @name est un objet de base de données autre qu’un type de données, sp_help retourne ce jeu de résultats et également des jeux de résultats supplémentaires, en fonction du type d’objet spécifié.

    Nom de la colonne Type de données Description
    Name nvarchar(128) Nom de table
    Owner 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, sp_help retourne les jeux de résultats suivants. Toutefois, le jeu de résultats qui décrit l’emplacement du fichier de données sur un groupe de fichiers n’est pas retourné pour une vue.

    • Le jeu de résultats suivant est également retourné sur les objets de colonne :

      Nom de la colonne Type de données Description
      Column_name nvarchar(128) Nom de la colonne.
      Type nvarchar(128) Type de données de colonne.
      Computed varchar(35) Indique si les valeurs de la colonne sont calculées : Yes ou No.
      Length int Longueur de colonne en octets.

      Remarque : Si le type de données de colonne est un type de valeur volumineux (varchar(max), nvarchar(max), varbinary(max)ou xml), la valeur s’affiche sous -1.
      Prec char(5) Précision de la colonne
      Scale char(5) Échelle de la colonne
      Nullable varchar(35) Indique si NULL les valeurs sont autorisées dans la colonne : Yes ou No.
      TrimTrailingBlanks varchar(35) Élimine les vides. Retourne Yes ou la valeur No.
      FixedLenNullInSource varchar(35) Ce paramètre est déconseillé et est maintenu pour la compatibilité descendante des scripts.
      Collation sysname Classement de la colonne. NULL pour les types de données non génériques.

    • Le jeu de résultats suivant est également retourné sur les colonnes d’identité :

      Nom de la 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 IDENTITY la propriété n’est pas appliquée lorsqu’une connexion de réplication, telle que sqlrepl, insère des données dans la table :

      1 = True
      0 = False

    • Le jeu de résultats suivant est également retourné sur les colonnes :

      Nom de la colonne Type de données Description
      RowGuidCol sysname Nom de la colonne d'identification unique.

    • Le jeu de résultats suivant est également retourné sur les groupes de fichiers :

      Nom de la colonne Type de données Description
      Data_located_on_filegroup nvarchar(128) Groupe de fichiers dans lequel se trouvent les données : Primary, Secondaryou Transaction Log.

    • Le jeu de résultats suivant est également retourné sur les index :

      Nom de la 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 NULL les index columnstore à mémoire optimisée.

    • Le jeu de résultats suivant est également retourné sur les 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 l’une des NO_ACTIONactions , , CASCADESET_NULL, SET_DEFAULTou N/A.

      Uniquement applicable aux contraintes FOREIGN KEY.
      update_action nvarchar(9) Indique si l’action UPDATE est l’une des NO_ACTIONactions , , CASCADESET_NULL, SET_DEFAULTou N/A.

      Applicable uniquement aux FOREIGN KEY contraintes.
      status_enabled varchar(8) Indique si la contrainte est activée : Enabled, Disabledou N/A.

      Applicable uniquement aux contraintes et FOREIGN KEY aux CHECK contraintes.
      status_for_replication varchar(19) Indique si la contrainte concerne la réplication.

      Applicable uniquement aux contraintes et FOREIGN KEY aux CHECK contraintes.
      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.

    • Le jeu de résultats suivant est également retourné sur le référencement d’objets :

      Nom de la 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.

    • Le jeu de résultats suivant est également retourné sur les procédures stockées, les fonctions ou les procédures stockées étendues.

      Nom de la 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 sp_help procédure recherche un objet dans la base de données active uniquement.

Lorsque @name n’est pas spécifié, répertorie les noms d’objets sp_help , les propriétaires et les types d’objets pour tous les objets de la base de données active. sp_helptrigger fournit des informations sur les déclencheurs.

sp_help expose uniquement les colonnes d’index triables ; par conséquent, il 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 disposer d’au moins une autorisation sur @objname. Pour afficher les clés de contrainte de colonne, les valeurs par défaut ou les règles, vous devez disposer VIEW DEFINITION d’autorisations sur la table.

Exemples

Les exemples de code Transact-SQL de cet article sont fondés sur l’échantillon de base de données AdventureWorks2022 ou AdventureWorksDW2022 fourni, que vous pouvez télécharger à partir de la page d’accueil Échantillons et projets communautaires Microsoft SQL Server.

R : Retourner des 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. Retourner des informations sur un seul objet

L'exemple suivant affiche des informations sur la table Person.Person.

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

Contenu connexe