sp_helptext (Transact-SQL)

Aplica-se a: SQL Server Banco de Dados SQL do Azure Instâ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, CHECK restrição, exibição ou objeto do sistema, como um procedimento armazenado do sistema.

Convenções de sintaxe de Transact-SQL

Sintaxe

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

Argumentos

@objname [ = ] n'objname'

O nome qualificado ou não qualificado de um objeto definido pelo usuário e com escopo de esquema. @objname é nvarchar(776), sem padrão. 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.

@columnname [ = ] N'columnname'

O nome da coluna computada para a qual exibir informações de definição. @columnname é sysname, com um padrão de NULL. A tabela que contém a coluna deve ser especificada como @objname.

Valores do código de retorno

0 (sucesso) ou 1 (falha).

Conjunto de resultados

Nome da coluna Tipo de dados Descrição
Text nvarchar(255) Definição do objeto

Comentários

sp_helptext Exibe a definição usada para criar um objeto em várias linhas. 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

Não há suporte para o procedimento sp_helptext armazenado do sistema no Azure Synapse Analytics. Em vez disso, use a OBJECT_DEFINITION função do sistema ou sys.sql_modules a exibição do catálogo de objetos para obter 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 de usuário é visível para o proprietário ou destinatários do objeto que têm qualquer uma das seguintes permissões: ALTER, CONTROL, TAKE OWNERSHIP, ou VIEW DEFINITION.

Exemplos

R. Exibir a definição de um gatilho

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

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

B. Exibir 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

Veja a seguir o conjunto de resultados.

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