sp_helptext (Transact-SQL)

Muestra definiciones de reglas definidas por el usuario, valores predeterminados, procedimientos almacenados de Transact-SQL no cifrados, funciones Transact-SQL definidas por el usuario, desencadenadores, columnas calculadas, restricciones CHECK, vistas u objetos del sistema, como un procedimiento almacenado del sistema.

Icono de vínculo a temasConvenciones de sintaxis de Transact-SQL

Sintaxis

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

Argumentos

  • [ @objname = ] 'name'
    Es el nombre, completo o no, de un objeto definido por el usuario en el á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 de tipo nvarchar(776) y no tiene valor predeterminado.

  • [@columnname = ] 'computed_column_name'
    Es el nombre de la columna calculada para la que se va a mostrar la definición. La tabla que contiene la columna se debe especificar como name. column_name es de tipo sysname y no tiene valor predeterminado.

Valores de código de retorno

0 (correcto) o 1 (error)

Conjuntos de resultados

Nombre de columna

Tipo de datos

Descripción

Text

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 columna definition de la vista de catálogo sys.sql_modules.

Permisos

Requiere la pertenencia 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 base de datos AdventureWorks2008R2.

USE AdventureWorks2008R2;
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 AdventureWorks2008R2.

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

El conjunto de resultados es el siguiente.

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