sp_helptext (Transact-SQL)

Exibe a definição de uma regra definida pelo usuário, um procedimento armazenado, padrão, não criptografado Transact-SQL, uma função Transact-SQL definida pelo usuário, um gatilho, uma coluna computada, uma restrição CHECK, uma exibição ou um objeto de sistema como um procedimento armazenado de sistema.

Ícone de vínculo de tópicoConvenções de sintaxe Transact-SQL

Sintaxe

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

Argumentos

  • [ @objname = ] 'name'
    É o nome qualificado ou não qualificado de um objeto de escopo de esquema definido pelo usuário. Somente serão requeridas aspas se um objeto qualificado for especificado. Se um nome completamente qualificado, incluindo um nome de banco de dados, for fornecido, o nome do banco de dados deverá ser o nome do banco de dados atual. O objeto deve estar no banco de dados atual. name é nvarchar(776), sem padrão.

  • [ @columnname = ] 'computed_column_name'
    É o nome da coluna computada para a qual exibir informações de definição. A tabela que contém a coluna deve ser especificada como name. column_name é sysname, sem padrão.

Valores de código de retorno

0 (êxito) ou 1 (falha)

Conjuntos de resultados

Nome da coluna

Tipo de dados

Descrição

Texto

nvarchar(255)

Definição do objeto

Comentários

sp_helptext exibe a definição que é usada para criar um objeto em linhas múltiplas. Cada linha contém 255 caracteres da definição Transact-SQL. A definição reside na coluna definição na exibição do catálogo de definição sys.sql_modules.

Permissões

Requer associação na função pública. Definições de objeto de sistema são publicamente visíveis. A definição de objetos de usuário é visível ao proprietário do objeto ou garante qualquer uma das seguintes permissões: ALTER, CONTROL, TAKE OWNERSHIP ou VIEW DEFINITION.

Exemplos

A. Exibindo a definição de um gatilho

O exemplo a seguir exibe a definição do gatilho uBillOfMaterials no banco de dados AdventureWorks.

USE AdventureWorks;
GO
EXEC sp_helptext 'Production.uBillOfMaterials';
GO

B. Exibindo a definição de uma coluna computada

O exemplo a seguir exibe a definição da coluna computada TotalDue na tabela SalesOrderHeader do banco de dados AdventureWorks.

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

Conjunto de resultados.

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