sys.dm_exec_describe_first_result_set_for_object (Transact-SQL)

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

Essa função de gerenciamento dinâmico usa um @object_id como um parâmetro e descreve os primeiros metadados de resultado para o módulo com essa ID. O @object_id especificado pode ser a ID de um procedimento armazenado Transact-SQL ou um gatilho Transact-SQL. Se for a ID de qualquer objeto (como exibição, tabela, função ou procedimento CLR), um erro será especificado nas colunas de erro do resultado.

sys.dm_exec_describe_first_result_set_for_object tem a mesma definição de conjunto de resultados que o sys.dm_exec_describe_first_result_set (Transact-SQL) e é semelhante ao sp_describe_first_result_set (Transact-SQL).

Convenções de sintaxe de Transact-SQL

Sintaxe

  
sys.dm_exec_describe_first_result_set_for_object   
    ( @object_id , @include_browse_information )  

Argumentos

@object_id
O @object_id de um procedimento armazenado Transact-SQL ou de um gatilho Transact-SQL. @object_id é do tipo int.

@include_browse_information
@include_browse_information é o tipo bit. Se definido como 1, cada consulta será analisada como se tivesse uma opção FOR BROWSE na consulta. Retorna colunas-chave adicionais e informações de tabela de origem.

Tabela retornada

Estes metadados comuns são retornados como um conjunto de resultados com uma linha para cada coluna nos metadados de resultados. Cada linha descreve o tipo e a nulidade da coluna no formato descrito na seção a seguir. Se a primeira instrução não existir para todo caminho de controle, um conjunto de resultados com zero linhas será retornado.

Nome da coluna	Tipo de dados	Descrição
is_hidden	bit	Especifica se a coluna é uma coluna extra adicionada para fins de informações de navegação e que ela não é exibida realmente no conjunto de resultados.
column_ordinal	int	Contém a posição ordinal da coluna no conjunto de resultados. A posição da primeira coluna será especificada como 1.
name	sysname	Conterá o nome da coluna se um nome puder ser determinado. Caso contrário, é NULL.
is_nullable	bit	Contém o valor 1 se a coluna permitir NULLs, 0 se a coluna não permitir NULLs e 1 se não puder ser determinado que a coluna permite NULLs.
system_type_id	int	Contém o system_type_id do tipo de dados da coluna especificada em sys.types. Para tipos de CLR, embora a coluna system_type_name retorne NULL, essa coluna retornará o valor 240.
system_type_name	nvarchar(256)	Contém o nome do tipo de dados. Inclui argumentos (como comprimento, precisão, escala) especificados para o tipo de dados da coluna. Se o tipo de dados for um tipo de alias definido pelo usuário, o tipo de sistema subjacente será especificado aqui. Se for um tipo de CLR definido pelo usuário, NULL será retornado nessa coluna.
max_length	smallint	Comprimento máximo (em bytes) da coluna. -1 = O tipo de dados de coluna é varchar(max), nvarchar(max), varbinary(max) ou xml. Para as colunas text, o valor max_length será 16 ou o valor definido por sp_tableoption 'text in row'.
precisão	tinyint	Precisão da coluna, se tiver base numérica. Caso contrário, retorna 0.
scale	tinyint	Escala da coluna, se tiver base numérica. Caso contrário, retorna 0.
collation_name	sysname	Nome da ordenação da coluna, se baseada em caracteres. Caso contrário, retorna NULL.
user_type_id	int	Para tipos de CLR e alias, contém o user_type_id do tipo de dados da coluna como especificado em sys.types. Caso contrário, é NULL.
user_type_database	sysname	Para tipos de CLR e de alias, contém o nome do banco de dados no qual o tipo é definido. Caso contrário, é NULL.
user_type_schema	sysname	Para tipos de CLR e de alias, contém o nome do esquema no qual o tipo é definido. Caso contrário, é NULL.
user_type_name	sysname	Para tipos de CLR e de alias, contém o nome do tipo. Caso contrário, é NULL.
assembly_qualified_type_name	nvarchar(4000)	Para tipos de CLR, retorna o nome do assembly e da classe que define o tipo. Caso contrário, é NULL.
xml_collection_id	int	Contém o xml_collection_id do tipo de dados da coluna como especificado em sys.columns. Essa coluna retornará NULL se o tipo retornado não estiver associado a uma coleção de esquemas XML.
xml_collection_database	sysname	Contém o banco de dados no qual a coleção de esquemas XML associada a esse tipo está definida. Essa coluna retornará NULL se o tipo retornado não estiver associado a uma coleção de esquemas XML.
xml_collection_schema	sysname	Contém o esquema no qual a coleção de esquemas XML associada a esse tipo está definida. Essa coluna retornará NULL se o tipo retornado não estiver associado a uma coleção de esquemas XML.
xml_collection_name	sysname	Contém o nome da coleção de esquemas XML associada a esse tipo. Essa coluna retornará NULL se o tipo retornado não estiver associado a uma coleção de esquemas XML.
is_xml_document	bit	Retornará 1 se o tipo de dados retornado for o XML e esse tipo for garantido de ser um documento XML completo (incluindo um nó raiz), em vez de um fragmento XML. Caso contrário, retorna 0.
is_case_sensitive	bit	Retornará 1 se a coluna for de um tipo de cadeia de caracteres com diferenciação de maiúsculas e minúsculas e 0 se não for.
is_fixed_length_clr_type	bit	Retornará 1 se a coluna for de um tipo de CLR de comprimento fixo e 0 se não for.
source_server	sysname	Nome do servidor de origem retornado pela coluna neste resultado (se a origem for um servidor remoto). O nome é atribuído quando exibido em sys.servers. Retorna NULL se a coluna for originada no servidor local ou se não for possível determinar em qual servidor ela se origina. Será populado somente se informações de navegação forem solicitadas.
source_database	sysname	Nome do banco de dados de origem retornado pela coluna neste resultado. Retornará NULL se o banco de dados não puder ser determinado. Será populado somente se informações de navegação forem solicitadas.
source_schema	sysname	Nome do esquema de origem retornado pela coluna neste resultado. Retornará NULL se o esquema não puder ser determinado. Será populado somente se informações de navegação forem solicitadas.
source_table	sysname	Nome da tabela de origem retornado pela coluna neste resultado. Retornará NULL se a tabela não puder ser determinada. Será populado somente se informações de navegação forem solicitadas.
source_column	sysname	Nome da coluna de origem retornada pela coluna neste resultado. Retornará NULL se a coluna não puder ser determinada. Será populado somente se informações de navegação forem solicitadas.
is_identity_column	bit	Retornará 1 se a coluna for uma coluna de identidade; caso contrário, retornará 0. Retornará NULL caso não seja possível determinar se a coluna é uma coluna de identidade.
is_part_of_unique_key	bit	Retornará 1 se a coluna fizer parte de um índice exclusivo (incluindo restrição exclusiva e primária); caso contrário, retornará 0. Retornará NULL caso não seja possível determinar se a coluna faz parte de um índice exclusivo. Será populado somente se informações de navegação forem solicitadas.
is_updateable	bit	Retornará 1 se a coluna for uma coluna atualizável; caso contrário, retornará 0. Retornará NULL caso não seja possível determinar se a coluna é atualizável.
is_computed_column	bit	Retornará 1 se a coluna for uma coluna computada; caso contrário, retornará 0. Retornará NULL caso não seja possível determinar se a coluna é uma coluna computada.
is_sparse_column_set	bit	Retornará 1 se a coluna for uma coluna esparsa; caso contrário, retornará 0. Retornará NULL caso não seja possível determinar se a coluna faz parte de um conjunto de colunas esparsas.
ordinal_in_order_by_list	smallint	A posição dessa coluna na lista ORDER BY. Retornará NULL se a coluna não for exibida na lista ORDER BY ou se a lista ORDER BY não puder ser determinada exclusivamente.
order_by_list_length	smallint	Comprimento da lista ORDER BY. Retornará NULL se não houver uma lista ORDER BY ou se a lista ORDER BY não puder ser determinada exclusivamente. Observe que este valor será o mesmo para todas as linhas retornadas por sp_describe_first_result_set.
order_by_is_descending	smallint NULL	Se o ordinal_in_order_by_list não for NULL, a coluna order_by_is_descending relatará a direção da cláusula ORDER BY para esta coluna. Caso contrário, relatará NULL.
error_number	int	Contém o número do erro retornado pela função. Conterá NULL se nenhum erro tiver ocorrido na coluna.
error_severity	int	Contém a severidade do erro retornado pela função. Conterá NULL se nenhum erro tiver ocorrido na coluna.
error_state	int	Contém a mensagem de estado retornada pela função. Se nenhum erro ocorreu. a coluna conterá NULL.
error_message	nvarchar(4096)	Contém a mensagem retornada pela função. Se nenhum erro ocorreu, a coluna conterá NULL.
error_type	int	Contém um inteiro que representa o erro que é retornado. Mapeia para error_type_desc. Consulte a lista sob comentários.
error_type_desc	nvarchar(60)	Contém uma pequena cadeia de caracteres maiúsculos que representa o erro sendo retornado. Mapeia para error_type. Consulte a lista sob comentários.

Comentários

Essa função usa o mesmo algoritmo que sp_describe_first_result_set. Para obter mais informações, consulte sp_describe_first_result_set (Transact-SQL).

A tabela a seguir lista os tipos de erros e suas descrições

error_type	error_type	Descrição
1	DIVERSOS	Todos os erros que não são descritos de outra forma.
2	SYNTAX	Um erro de sintaxe ocorreu no lote.
3	CONFLICTING_RESULTS	O resultado não pôde ser determinado devido a um conflito entre duas primeiras instruções possíveis.
4	DYNAMIC_SQL	O resultado não pôde ser determinado devido a um SQL dinâmico que poderia retornar o primeiro resultado.
5	CLR_PROCEDURE	O resultado não pôde ser determinado devido a um procedimento armazenado de CLR que poderia retornar o primeiro resultado.
6	CLR_TRIGGER	O resultado não pôde ser determinado devido a um gatilho CLR que poderia retornar o primeiro resultado.
7	EXTENDED_PROCEDURE	O resultado não pôde ser determinado devido a um procedimento armazenado estendido que poderia retornar o primeiro resultado.
8	UNDECLARED_PARAMETER	O resultado não pôde ser determinado porque o tipo de dados de uma ou mais colunas do conjunto de resultados depende potencialmente de um parâmetro não declarado.
9	RECURSION	O resultado não pôde ser determinado porque o lote contém uma instrução recursiva.
10	TEMPORARY_TABLE	O resultado não pôde ser determinado porque o lote contém uma tabela temporária e não é suportado pelo sp_describe_first_result_set .
11	UNSUPPORTED_STATEMENT	O resultado não pôde ser determinado porque o lote contém uma instrução que não é suportada por sp_describe_first_result_set (por exemplo, FETCH, REVERT etc.).
12	OBJECT_ID_NOT_SUPPORTED	Não há suporte para a @object_id função passada (ou seja, não é um procedimento armazenado)
13	OBJECT_ID_DOES_NOT_EXIST	O @object_id passado para a função não foi encontrado no catálogo do sistema.

Permissões

Requer permissão para executar o @tsql argumento.

Exemplos

R. Retornando metadados com e sem informações de procura

O exemplo a seguir cria um procedimento armazenado chamado TestProc2 que retorna dois conjuntos de resultados. Em seguida, o exemplo demonstra que sys.dm_exec_describe_first_result_set retorna informações sobre o primeiro conjunto de resultados no procedimento, com e sem as informações de navegação.

CREATE PROC TestProc2  
AS  
SELECT object_id, name FROM sys.objects ;  
SELECT name, schema_id, create_date FROM sys.objects ;  
GO  
  
SELECT * FROM sys.dm_exec_describe_first_result_set_for_object(OBJECT_ID('TestProc2'), 0) ;  
SELECT * FROM sys.dm_exec_describe_first_result_set_for_object(OBJECT_ID('TestProc2'), 1) ;  
GO  

B. Combinando a função sys.dm_exec_describe_first_result_set_for_object e uma tabela ou exibição

O exemplo a seguir usa a exibição de catálogo do sistema sys.procedures e a função sys.dm_exec_describe_first_result_set_for_object para exibir metadados para os conjuntos de resultados de todos os procedimentos armazenados no AdventureWorks2022 banco de dados.

USE AdventureWorks2022;  
GO  
  
SELECT p.name, r.*   
FROM sys.procedures AS p  
CROSS APPLY sys.dm_exec_describe_first_result_set_for_object(p.object_id, 0) AS r;  
GO  
  

Confira também

sp_describe_first_result_set (Transact-SQL)
sp_describe_undeclared_parameters (Transact-SQL)
sys.dm_exec_describe_first_result_set (Transact-SQL)