sp_helptext (Transact-SQL)

Aplica-se a:SQL ServerBanco de Dados SQL do AzureInstância Gerenciada de SQL do Azure

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

Convenções de sintaxe de Transact-SQL

Sintaxe

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

Argumentos

[ @objname = ] 'name' É o nome qualificado ou não qualificado de um objeto com 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 nome. column_name é sysname, sem padrão.

Valores do 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 definition coluna na exibição do catálogo sys.sql_modules.

Observação

O procedimento armazenado do sistema sp_helptext não tem suporte no Azure Synapse Analytics. Em vez disso, use OBJECT_DEFINITION a função do sistema ou sys.sql_modules a exibição do catálogo de objetos para resultados equivalentes.

Permissões

Requer associação à função pública . Definições de objeto de sistema são publicamente visíveis. A definição de objetos do usuário é visível ao proprietário do objeto e às entidades autorizadas que tiverem 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 dEmployee no AdventureWorks2022banco de dados.

USE AdventureWorks2022;  
GO  
EXEC sp_helptext 'HumanResources.dEmployee';  
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 AdventureWorks2022.

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

Este é o conjunto de resultados.

Text

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

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

Consulte Também

Procedimentos armazenados do Mecanismo de Banco de Dados (Transact-SQL)
OBJECT_DEFINITION (Transact-SQL)
sp_help (Transact-SQL)
sys.sql_modules (Transact-SQL)
Procedimentos armazenados do sistema (Transact-SQL)