sys.dm_exec_describe_first_result_set (Transact-SQL)

Se aplica a:SQL ServerAzure SQL DatabaseAzure SQL Managed Instance

Esta función de administración dinámica toma una instrucción Transact-SQL como parámetro y describe los metadatos del primer conjunto de resultados para la instrucción .

sys.dm_exec_describe_first_result_set tiene la misma definición de conjunto de resultados que sys.dm_exec_describe_first_result_set_for_object (Transact-SQL) y es similar a sp_describe_first_result_set (Transact-SQL).

Convenciones de sintaxis de Transact-SQL

Sintaxis

  
sys.dm_exec_describe_first_result_set(@tsql, @params, @include_browse_information)  

Argumentos

@tsql
Una o varias instrucciones Transact-SQL. Transact-SQL_batch puede ser nvarchar(n) o nvarchar(max).

@params
@params proporciona una cadena de declaración para los parámetros del lote de Transact-SQL, similar a sp_executesql. Los parámetros pueden ser nvarchar(n) o nvarchar(max).

Se trata de una cadena que contiene las definiciones de todos los parámetros que se han incrustado en Transact-SQL_batch. La cadena debe ser una constante Unicode o una variable Unicode. Cada definición de parámetro se compone de un nombre de parámetro y un tipo de datos. n es un marcador de posición que indica definiciones de parámetros adicionales. Todos los parámetros especificados en stmt deben definirse en @params. Si el lote o la instrucción de Transact-SQL de la instrucción no contiene parámetros, @params no es necesario. NULL es el valor predeterminado para este parámetro.

@include_browse_information
Si está establecido en 1, cada consulta se analiza como si tuviera una opción FOR BROWSE en la consulta. Se devuelven las columnas de clave adicionales e información de la tabla de origen.

Tabla devuelta

Estos metadatos comunes se devuelven como un conjunto de resultados. Una fila para cada columna de los metadatos de resultados describe el tipo y la nulabilidad de la columna en el formato que se muestra en la siguiente tabla. Si la primera instrucción no existe en cada una de las rutas de acceso de control, se devuelve un conjunto de resultados con cero filas.

Comentarios

Esta función utiliza el mismo algoritmo que sp_describe_first_result_set. Para obtener más información, consulte sp_describe_first_result_set (Transact-SQL).

En la tabla siguiente se muestran los tipos de error y su descripción.

Permisos

Se requiere permiso para ejecutar el argumento @tsql.

Ejemplos

Se pueden adaptar ejemplos adicionales en el tema sp_describe_first_result_set (Transact-SQL) para usar sys.dm_exec_describe_first_result_set.

A. Devolver información acerca de una sola instrucción de Transact-SQL

El código siguiente devuelve información sobre los resultados de una instrucción 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. Devolver información acerca de un procedimiento

En el ejemplo siguiente se crea un procedimiento almacenado denominado pr_TestProc que devuelve dos conjuntos de resultados. En el ejemplo se muestra que sys.dm_exec_describe_first_result_set devuelve información acerca del primer conjunto de resultados del procedimiento.

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. Devolver los metadatos de un lote que contiene varias instrucciones

En el ejemplo siguiente se evalúa un lote que contiene dos instrucciones Transact-SQL. El conjunto de resultados describe el primer conjunto de resultados devuelto.

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  

Consulte también

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