sp_helptext (Transact-SQL)

S’applique à :SQL ServerAzure SQL DatabaseAzure SQL Managed Instance

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

Conventions de la syntaxe Transact-SQL

Syntaxe

sp_helptext [ @objname = ] 'name' [ , [ @columnname = ] computed_column_name ]  

Arguments

[ @objname = ] 'name' Nom qualifié ou non qualifié d’un objet défini par l’utilisateur au niveau du schéma. 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. name est nvarchar(776), sans valeur par défaut.

[ @columnname = ] 'computed_column_name' Nom de la colonne calculée pour laquelle afficher les informations de définition. La table qui contient la colonne doit être spécifiée comme nom. column_name est sysname, sans valeur par défaut.

Codet de retour

0 (réussite) ou 1 (échec)

Jeux de résultats

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

Remarques

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 dans la vue catalogue sys.sql_modules .

Notes

La procédure stockée système sp_helptext n’est pas prise en charge dans Azure Synapse Analytics. Utilisez plutôt la OBJECT_DEFINITION fonction système ou sys.sql_modules la vue 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 de l’objet ou les bénéficiaires de l’une des autorisations suivantes : ALTER, CONTROL, TAKE OWNERSHIP ou VIEW DEFINITION.

Exemples

R. Affichage de la définition d'un déclencheur

L’exemple suivant montre comment afficher la définition du déclencheur dEmployee dans la AdventureWorks2022base de données.

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

B. Affichage de 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 obtenu.

Text

---------------------------------------------------------------------

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

Voir aussi

Procédures stockées du moteur de base de données (Transact-SQL)
OBJECT_DEFINITION (Transact-SQL)
sp_help (Transact-SQL)
sys.sql_modules (Transact-SQL)
Procédures stockées système (Transact-SQL)