sp_helptext (Transact-SQL)

  • Artículo

Se aplica a:SQL ServerAzure SQL DatabaseAzure SQL Managed Instance

Muestra la definición de una regla definida por el usuario, el procedimiento almacenado de Transact-SQL sin cifrar, la función Transact-SQL definida por el usuario, el desencadenador, la columna calculada, la restricción CHECK, la vista o el objeto del sistema, como un procedimiento almacenado del sistema.

Convenciones de sintaxis de Transact-SQL

Sintaxis

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

Argumentos

[ @objname = ] 'name' Es el nombre completo o no calificado de un objeto definido por el usuario y con ámbito de esquema. Se requieren comillas solo si se especifica un nombre de objeto calificado. Si se proporciona un nombre completo, incluido el nombre de la base de datos, el nombre de la base de datos debe ser el de la base de datos actual. El objeto debe estar en la base de datos actual. name es nvarchar(776), sin ningún valor predeterminado.

[ @columnname = ] 'computed_column_name' Es el nombre de la columna calculada para la que se va a mostrar información de definición. La tabla que contiene la columna debe especificarse como nombre. column_name es sysname, sin ningún valor predeterminado.

Valores de código de retorno

0 (correcto) o 1 (error)

Conjuntos de resultados

Nombre de la columna Tipo de datos Descripción
Texto nvarchar(255) Definición del objeto

Comentarios

sp_helptext muestra la definición que se utiliza para crear un objeto en varias filas. Cada fila contiene 255 caracteres de la definición de Transact-SQL. La definición reside en la definition columna de la vista de catálogo sys.sql_modules .

Nota:

El procedimiento almacenado del sistema sp_helptext no es compatible con Azure Synapse Analytics. En su lugar, use OBJECT_DEFINITION la función del sistema o sys.sql_modules la vista de catálogo de objetos para obtener resultados equivalentes.

Permisos

Debe pertenecer al rol public . Las definiciones de los objetos del sistema están visibles públicamente. La definición de los objetos de usuario está visible para el propietario del objeto o los receptores de los permisos siguientes: ALTER, CONTROL, TAKE OWNERSHIP o VIEW DEFINITION.

Ejemplos

A. Mostrar la definición de un desencadenador

En el ejemplo siguiente se muestra la definición del desencadenador dEmployee en la AdventureWorks2022base de datos.

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

B. Mostrar la definición de una columna calculada

En el ejemplo siguiente se muestra la definición de la columna calculada TotalDue de la tabla SalesOrderHeader de la base de datos AdventureWorks2022.

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

El conjunto de resultados es el siguiente:

Text

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

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

Consulte también

Procedimientos almacenados del motor de base de datos (Transact-SQL)
OBJECT_DEFINITION (Transact-SQL)
sp_help (Transact-SQL)
sys.sql_modules (Transact-SQL)
Procedimientos almacenados del sistema (Transact-SQL)