sys.dm_exec_describe_first_result_set_for_object (Transact-SQL)

Область применения: SQL Server База данных SQL Azure Управляемый экземпляр SQL Azure

Эта динамическая функция управления принимает в @object_id качестве параметра и описывает первые метаданные результатов для модуля с таким идентификатором. Это @object_id может быть идентификатор хранимой процедуры Transact-SQL или триггера Transact-SQL. Если же передан идентификатор любого другого объекта (представления, функции, таблицы или процедуры CLR), то в столбцах ошибки результата будет содержаться ошибка.

sys.dm_exec_describe_first_result_set_for_object имеет то же определение результирующих наборов, что и sys.dm_exec_describe_first_result_set (Transact-SQL) и аналогично sp_describe_first_result_set (Transact-SQL).

Соглашения о синтаксисе Transact-SQL

Синтаксис

  
sys.dm_exec_describe_first_result_set_for_object   
    ( @object_id , @include_browse_information )  

Аргументы

@object_id
Хранимая @object_id процедура Transact-SQL или триггер Transact-SQL. @object_id имеет тип int.

@include_browse_information
@include_browse_informationимеет бит типа. Если имеет значение 1, то каждый запрос анализируется так, как будто он имеет параметр FOR BROWSE для запроса. Возвращает дополнительные ключевые столбцы и сведения об исходной таблице.

Возвращаемая таблица

Эти общие метаданные возвращаются в виде результирующего набора с одной строкой для каждого столбца в результирующих метаданных. Каждая строка описывает тип и допустимость значений NULL в столбце в формате, описанном в следующем разделе. Если первая инструкция не существует для каждого пути управления, возвращается результирующий набор с нулем строк.

Замечания

Эта функция использует тот же алгоритм, что и sp_describe_first_result_set. Дополнительные сведения см. в разделе sp_describe_first_result_set (Transact-SQL).

В следующей таблице содержится список типов ошибок и их описания

Разрешения

Требуется разрешение на выполнение аргумента @tsql .

Примеры

А. Возвращает метаданные со сведениями для просмотра и без них

В следующем примере создается хранимая процедура с именем TestProc2, которая возвращает два результирующих набора. Затем в примере показано, что sys.dm_exec_describe_first_result_set возвращает сведения о первом результирующем наборе в процедуре и без сведений о просмотре.

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. Объединение функции sys.dm_exec_describe_first_result_set_for_object с таблицей или представлением

В следующем примере используется представление системного каталога sys.procedures и функция sys.dm_exec_describe_first_result_set_for_object для отображения метаданных для результирующих наборов всех хранимых процедур в AdventureWorks2022 базе данных.

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  
  

См. также

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