sp_helptext (Transact-SQL)

  • Artículo

Se aplica a: SQL Server Azure SQL Database Azure SQL Managed Instance

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

Convenciones de sintaxis de Transact-SQL

Sintaxis

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

Argumentos

[ @objname = ] N'objname'

Nombre completo o no calificado de un objeto definido por el usuario con ámbito de esquema. @objname es nvarchar(776), sin ningún valor predeterminado. 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.

[ @columnname = ] N'columnname'

Nombre de la columna calculada para la que se va a mostrar información de definición. @columnname es sysname, con un valor predeterminado de NULL. La tabla que contiene la columna debe especificarse como @objname.

Valores de código de retorno

0 (correcto) o 1 (erróneo).

Conjunto de resultados

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

Comentarios

sp_helptext muestra la definición que se usa 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 sp_helptext almacenado del sistema no se admite en 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 objetos de usuario es visible para el propietario del objeto o receptores que tienen cualquiera de los permisos siguientes: ALTER, CONTROL, TAKE OWNERSHIPo 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 AdventureWorks2022 base 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

Este es el conjunto de resultados.

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

Contenido relacionado