sys.dm_exec_describe_first_result_set_for_object (Transact-SQL)

Se aplica a: SQL ServerAzure SQL Database Azure SQL Instancia administrada

Esta función de administración dinámica toma como @object_id parámetro y describe los primeros metadatos de resultado para el módulo con ese identificador. El @object_id especificado puede ser el identificador de un procedimiento almacenado de Transact-SQL o un desencadenador de Transact-SQL. Si es el identificador de cualquier otro objeto (como una vista, tabla, función o procedimiento CLR), se especificará un error en las columnas de error del resultado.

sys.dm_exec_describe_first_result_set_for_object tiene la misma definición del conjunto de resultados que sys.dm_exec_describe_first_result_set (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_for_object   
    ( @object_id , @include_browse_information )  

Argumentos

@object_id
@object_id de un procedimiento almacenado de Transact-SQL o un desencadenador de Transact-SQL. @object_id es de tipo int.

@include_browse_information
@include_browse_information es de tipo bit. Si está establecido en 1, cada consulta se analiza como si tuviera una opción FOR BROWSE en la consulta. Devuelve 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 con una única fila por cada columna de los metadatos de los resultados. Cada fila describe el tipo y la nulabilidad de la columna en el formato descrito en la siguiente sección. 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 usa 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

Requiere permiso para ejecutar el @tsql argumento.

Ejemplos

A Devolver los metadatos con y sin información de exploración

En el ejemplo siguiente se crea un procedimiento almacenado denominado TestProc2 que devuelve dos conjuntos de resultados. A continuación, el ejemplo muestra que sys.dm_exec_describe_first_result_set devuelve información sobre el primer conjunto de resultados del procedimiento, con y sin la información de exploración.

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. Combinar la función sys.dm_exec_describe_first_result_set_for_object y una tabla o vista

En el ejemplo siguiente se usa la vista de catálogo del sistema sys.procedures y la función sys.dm_exec_describe_first_result_set_for_object para mostrar los metadatos de los conjuntos de resultados de todos los procedimientos almacenados de la AdventureWorks2022 base de datos.

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  
  

Consulte también

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