sp_helptext (Transact-SQL)

  • Article

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

Affiche la définition d’une règle définie par l’utilisateur, une procédure stockée Transact-SQL non chiffrée, une fonction Transact-SQL définie par l’utilisateur, un déclencheur, une colonne calculée, CHECK une contrainte, une vue ou un objet système tel qu’une procédure stockée système.

Conventions de la syntaxe Transact-SQL

Syntaxe

sp_helptext
    [ @objname = ] N'objname'
    [ , [ @columnname = ] N'columnname' ]
[ ; ]

Arguments

[ @objname = ] N’objname'

Nom qualifié ou non qualifié d’un objet défini par l’utilisateur et délimité par un schéma. @objname est nvarchar(776), sans valeur par défaut. Les guillemets ne sont nécessaires que si un objet qualifié est spécifié. Si un nom qualifié complet (incluant un nom de base de données) est fourni, le nom de base de données doit être celui de la base de données active. Cet objet doit exister dans la base de données active.

[ @columnname = ] N’columnname'

Nom de la colonne calculée pour laquelle afficher les informations de définition. @columnname est sysname, avec la valeur par défaut NULL. La table qui contient la colonne doit être spécifiée comme @objname.

Valeurs des codes de retour

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

Jeu de résultats

Nom de la colonne Type de données Description
Text nvarchar(255) Définition de l'objet

Notes

sp_helptext affiche la définition utilisée pour créer un objet dans plusieurs lignes. Chaque ligne contient 255 caractères de la définition Transact-SQL. La définition réside dans la definition colonne de l’affichage catalogue sys.sql_modules .

Remarque

La procédure sp_helptext stockée système n’est pas prise en charge dans Azure Synapse Analytics. Utilisez plutôt la OBJECT_DEFINITION fonction système ou sys.sql_modules l’affichage catalogue d’objets pour obtenir des résultats équivalents.

autorisations

Nécessite l'appartenance au rôle public . Les définitions de l'objet système sont visibles publiquement. La définition des objets utilisateur est visible par le propriétaire ou les bénéficiaires de l’objet qui ont l’une des autorisations suivantes : ALTER, CONTROLTAKE OWNERSHIPou VIEW DEFINITION.

Exemples

R. Afficher la définition d’un déclencheur

L’exemple suivant affiche la définition du déclencheur dEmployee dans la AdventureWorks2022 base de données.

USE AdventureWorks2022;
GO
EXEC sp_helptext 'HumanResources.dEmployee';
GO

B. Afficher la définition d’une colonne calculée

L'exemple suivant affiche la définition de la colonne calculée TotalDue dans la table SalesOrderHeader de la base de données AdventureWorks2022.

USE AdventureWorks2022;
GO
sp_helptext
    @objname = N'AdventureWorks2022.Sales.SalesOrderHeader',
    @columnname = TotalDue;
GO

Voici le jeu de résultats.

Text
---------------------------------------------------------------------
(isnull(([SubTotal]+[TaxAmt])+[Freight],(0)))

Contenu connexe