sys.dm_exec_describe_first_result_set (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 uma instrução Transact-SQL como parâmetro e descreve os metadados do primeiro conjunto de resultados para a instrução.

sys.dm_exec_describe_first_result_set tem a mesma definição de conjunto de resultados que o sys.dm_exec_describe_first_result_set_for_object (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(@tsql, @params, @include_browse_information)  

Argumentos

@tsql
Uma ou mais instruções Transact-SQL. Transact-SQL_batch pode ser nvarchar(n) ou nvarchar(max).

@params
@params fornece uma cadeia de caracteres de declaração para parâmetros para o lote Transact-SQL, semelhante ao sp_executesql. Os parâmetros podem ser nvarchar(n) ou nvarchar(max).

É uma cadeia de caracteres que contém as definições de todos os parâmetros inseridos na instrução Transact-SQL_batch. A cadeia de caracteres deve ser uma constante Unicode ou uma variável Unicode. Cada definição de parâmetro consiste em um nome de parâmetro e um tipo de dados. n é um espaço reservado que indica definições de parâmetro adicionais. Cada parâmetro especificado em stmt deve ser definido em @params. Se a instrução Transact-SQL ou lote na instrução não contiverem parâmetros, @params não será necessário. O valor padrão para este parâmetro é NULL.

@include_browse_information
Se definido como 1, cada consulta será analisada como se tivesse uma opção FOR BROWSE na consulta. Colunas de chave adicionais e informações de tabela de origem são retornadas.

Tabela retornada

Esses metadados comuns são retornados como um conjunto de resultados. Uma linha para cada coluna nos metadados de resultados descreve o tipo e a nulidade da coluna no formato mostrado na tabela 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 que 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. Se não, conterá NULL.
is_nullable	bit	Contém os seguintes valores: Valor 1 se a coluna permitir NULLs. Valor 0 se a coluna não permitir NULLs. Valor 1 se não for possível determinar se a coluna permite NULLs.
system_type_id	int	Contém o system_type_id do tipo de dados de coluna, conforme especificado 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 e 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 o tipo de dados for um tipo 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 um tipo de cadeia de caracteres com diferenciação de maiúsculas e minúsculas. Retornará 0 se não estiver.
is_fixed_length_clr_type	bit	Retornará 1 se a coluna for de um tipo de CLR de comprimento fixo. Retornará 0 se não estiver.
source_server	sysname	Nome do servidor de origem (se for originado de um servidor remoto). O nome é atribuído quando exibido em sys.servers. Retornará NULL se a coluna tiver origem no servidor local ou caso não seja possível determinar o servidor de origem. 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 retornado pela coluna de 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 as restrições exclusivas e primárias); 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 desta coluna na lista ORDER BY. Retornará o 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	O comprimento da lista ORDER BY. NULL será retornado 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. Se nenhum erro ocorreu, a coluna conterá NULL.
error_severity	int	Contém a severidade do erro retornado pela função. Se nenhum erro ocorreu, a coluna conterá NULL.
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_TYPE_NOT_SUPPORTED	Não há suporte para o @object_id passado para a função (ou seja, não é um procedimento armazenado)
13	OBJECT_DOES_NOT_EXIST	O @object_id passado para a função não foi encontrado no catálogo do sistema.

Permissões

Exige permissão para executar o argumento @tsql.

Exemplos

Exemplos adicionais no tópico sp_describe_first_result_set (Transact-SQL) podem ser adaptados para usar sys.dm_exec_describe_first_result_set.

R. Retornando informações sobre uma única instrução Transact-SQL

O código a seguir retorna informações sobre os resultados de uma instrução Transact-SQL.

USE AdventureWorks2022;  
GO  
SELECT * FROM sys.dm_exec_describe_first_result_set  
(N'SELECT object_id, name, type_desc FROM sys.indexes', null, 0) ;  

B. Retornando informações sobre um procedimento

O exemplo a seguir cria um procedimento armazenado chamado pr_TestProc 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.

USE AdventureWorks2022;  
GO  
  
CREATE PROC Production.TestProc  
AS  
SELECT Name, ProductID, Color FROM Production.Product ;  
SELECT Name, SafetyStockLevel, SellStartDate FROM Production.Product ;  
GO  
  
SELECT * FROM sys.dm_exec_describe_first_result_set  
('Production.TestProc', NULL, 0) ;  

C. Retornando metadados de um lote que contém várias instruções

O exemplo a seguir avalia um lote que contém duas instruções Transact-SQL. O conjunto de resultados descreve o primeiro conjunto de resultados retornado.

USE AdventureWorks2022;  
GO  
  
SELECT * FROM sys.dm_exec_describe_first_result_set(  
N'SELECT CustomerID, TerritoryID, AccountNumber FROM Sales.Customer WHERE CustomerID = @CustomerID;  
SELECT * FROM Sales.SalesOrderHeader;',  
N'@CustomerID int', 0) AS a;  
GO  

Confira também

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