sys.dm_exec_describe_first_result_set (Transact-SQL)

Статья
05/30/2023

Применяется к:SQL Server Azure SQL Database Azure, управляемому экземпляру SQL Azure

Эта динамическая функция управления принимает инструкцию Transact-SQL в качестве параметра и описывает метаданные первого результирующий набор для инструкции.

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

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

Синтаксис

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

Аргументы

@tsql
Одна или несколько инструкций Transact-SQL. Transact-SQL_batch может быть nvarchar(n) или nvarchar(max).

@params
@params предоставляет строку объявления для параметров пакета Transact-SQL, аналогично sp_executesql. Параметры могут быть nvarchar(n) или nvarchar(max).

Одна строка, содержащая определения всех параметров, внедренных в Transact-SQL_batch. Строка должна представлять собой константу в Юникоде либо переменную в этом же формате. Определение каждого параметра состоит из имени параметра и типа данных. n — это заполнитель, указывающий дополнительные определения параметров. Каждый параметр, указанный в stmt, должен быть определен в @params. Если инструкция Transact-SQL или пакет в инструкции не содержит параметров, @params не требуется. Значением по умолчанию для этого аргумента является NULL.

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

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

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

Имя столбца	Тип данных	Описание:
is_hidden	bit	Указывает, что столбец является дополнительным, добавленным в информационных целях и для просмотра сведений и фактически не присутствует в результирующем наборе.
column_ordinal	int	Содержит порядковый номер столбца в результирующем наборе. Позиция первого столбца будет указана как 1.
name	sysname	Содержит имя столбца, если его можно определить. В противном случае содержит NULL.
is_nullable	bit	Содержит следующие значения. Значение 1, если в столбце допускаются значения NULL. Значение 0, если в столбце не допускаются значения NULL. Значение 1, если невозможно определить, допускаются ли в столбце значения NULL.
system_type_id	int	Содержит system_type_id типа данных столбца, указанного в sys.types. Для типов CLR, даже если system_type_name возвращает NULL, этот столбец вернет значение 240.
system_type_name	nvarchar(256)	Содержит имя и аргументы (длина, точность, масштаб и т. д.), указанные для типа данных столбца. Если тип данных является пользовательским псевдонимом, то здесь указывается базовый системный тип данных. Если тип данных является определенным пользователем типом CLR, то в этом столбце возвращается NULL.
max_length	smallint	Максимальная длина столбца (в байтах). -1 = типом данных столбца является varchar(max), nvarchar(max), varbinary(max) или xml. Для текстовых столбцов значением max_length будет 16 или значение параметра "text in row", установленное процедурой sp_tableoption.
precision	tinyint	Точность столбца, если он является числовым. В противном случае возвращает 0.
scale	tinyint	Масштаб значений столбца в случае числового выражения. В противном случае возвращает 0.
collation_name	sysname	Имя параметров сортировки столбца, если он символьный. В противном случае возвращается NULL.
user_type_id	int	Для типов CLR и псевдонимов содержит user_type_id для типа данных столбца, как указано в sys.types. В противном случае значение равно NULL.
user_type_database	sysname	Для типов CLR и псевдонимов содержит имя базы данных, в которой этот тип определен. В противном случае значение равно NULL.
user_type_schema	sysname	Для типов CLR и псевдонимов содержит имя схемы, в которой этот тип определен. В противном случае значение равно NULL.
user_type_name	sysname	Для типов CLR и псевдонимов содержит имя типа. В противном случае значение равно NULL.
assembly_qualified_type_name	nvarchar(4000)	Для типов CLR возвращает имя сборки и класса, определяющего тип. В противном случае значение равно NULL.
xml_collection_id	int	Содержит xml_collection_id для типа данных столбца, как указано в sys.columns. Этот столбец возвращает значение NULL, если возвращаемый тип не связан с коллекцией схем XML.
xml_collection_database	sysname	Содержит базу данных, в которой определена коллекция схем XML, связанная с этим типом. Этот столбец возвращает значение NULL, если возвращаемый тип не связан с коллекцией схем XML.
xml_collection_schema	sysname	Содержит схему, в которой определена коллекция схем XML, связанная с этим типом. Этот столбец возвращает значение NULL, если возвращаемый тип не связан с коллекцией схем XML.
xml_collection_name	sysname	Содержит имя коллекции схем XML, связанной с этим типом. Этот столбец возвращает значение NULL, если возвращаемый тип не связан с коллекцией схем XML.
is_xml_document	bit	Возвращает значение 1, если возвращается тип данных XML, который гарантированно будет полным XML-документом (включая корневой узел), а не фрагментом XML. В противном случае возвращает 0.
is_case_sensitive	bit	Возвращает значение 1, если столбец относится к строковому типу с учетом регистра. В противном случае возвращается значение 0.
is_fixed_length_clr_type	bit	Возвращает значение 1, если столбец относится к типу CLR с фиксированной длиной. В противном случае возвращается значение 0.
source_server	sysname	Имя сервера происхождения (в случае происхождения от удаленного сервера). Имя присваивается, как оно отображается в sys.servers. Возвращает NULL, если столбец поступает с локального сервера или если невозможно определить, с какого сервера он поступил. Заполняется только при запросе просмотра информации.
source_database	sysname	Имя исходной базы данных, возвращаемое столбцом этого результата. Возвращает NULL, если не удалось определить базу данных. Заполняется только при запросе просмотра информации.
source_schema	sysname	Имя исходной схемы, возвращаемое столбцом в этом результате. Возвращает NULL, если не удалось определить схему. Заполняется только при запросе просмотра информации.
source_table	sysname	Имя исходной таблицы, возвращаемое столбцом в этом результате. Возвращает NULL, если не удалось определить таблицу. Заполняется только при запросе просмотра информации.
source_column	sysname	Имя исходного столбца, возвращаемое результирующим столбцом. Возвращает NULL, если не удалось определить столбец. Заполняется только при запросе просмотра информации.
is_identity_column	bit	Возвращает значение 1, если столбец является столбцом идентификаторов, либо значение 0 в противном случае. Возвращает NULL, если не удалось определить, является ли столбец столбцом идентификаторов.
is_part_of_unique_key	bit	Возвращает значение 1, если столбец является частью уникального индекса (включая ограничения уникальности и первичности), либо значение 0 в противном случае. Возвращает NULL, если не удалось определить, является ли столбец частью уникального индекса. Заполняется только при запросе просмотра информации.
is_updateable	bit	Возвращает значение 1, если столбец можно обновлять, либо значение 0 в противном случае. Возвращает NULL, если не удалось определить, можно ли обновлять столбец.
is_computed_column	bit	Возвращает значение 1, если столбец является вычисляемым столбцом, либо значение 0 в противном случае. Возвращает NULL, если не удается определить, является ли столбец вычисляемым столбцом.
is_sparse_column_set	bit	Возвращает значение 1, если столбец является разреженным, и значение 0 в противном случае. Возвращает NULL, если не удалось определить, является ли столбец частью набора разреженных столбцов.
ordinal_in_order_by_list	smallint	положение этого столбца в списке ORDER BY. Возвращает NULL, если столбец отсутствует в списке ORDER BY или если список ORDER BY нельзя определить однозначно.
order_by_list_length	smallint	Длина списка ORDER BY. Возвращает NULL, если список ORDER BY отсутствует или если список ORDER BY нельзя однозначно определить. Обратите внимание на то, что это значение будет одним и тем же для всех строк, возвращаемых процедурой sp_describe_first_result_set.
order_by_is_descending	smallint NULL	Если ordinal_in_order_by_list не равно NULL, столбец order_by_is_descending сообщает направление предложения ORDER BY для этого столбца. В противном случае возвращается значение NULL.
error_number	int	Содержит номер ошибки, возвращаемый этой функцией. Столбец будет содержать NULL, если не возникло ошибок.
error_severity	int	Содержит серьезность ошибки, возвращаемую этой функцией. Столбец будет содержать NULL, если не возникло ошибок.
error_state	int	Содержит сообщение о состоянии. возвращенное функцией. Столбец будет содержать NULL, если не возникло ошибок.
error_message	nvarchar(4096)	Содержит сообщение, возвращаемое этой функцией. Столбец будет содержать NULL, если не возникло ошибок.
error_type	int	Содержит целое число, представляющее возвращаемую ошибку. Соответствует error_type_desc. См. список под замечаниями.
error_type_desc	nvarchar(60)	Содержит короткую строку в верхнем регистре, представляющую возвращаемую ошибку. Сопоставляется с error_type. См. список под замечаниями.

Замечания

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

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

error_type	error_type	Description
1	ПРОЧЕЕ	Все ошибки, которые не описаны иным образом.
2	SYNTAX	В пакете возникла синтаксическая ошибка.
3	CONFLICTING_RESULTS	Результат удалось определить из-за конфликта между двумя возможными первыми инструкциями.
4	DYNAMIC_SQL	Результат не удалось определить из-за динамического SQL, который потенциально мог вернуть первый результат.
5	CLR_PROCEDURE	Результат не удалось определить из-за того, что хранимая процедура CLR потенциально могла вернуть первый результат.
6	CLR_TRIGGER	Результат не удалось определить из-за того, что триггер CLR потенциально мог вернуть первый результат.
7	EXTENDED_PROCEDURE	Результат не удалось определить из-за того, что расширенная хранимая процедура потенциально могла вернуть первый результат.
8	UNDECLARED_PARAMETER	Результат не удалось определить, так как тип данных одного или нескольких столбцов результирующего набора потенциально зависит от необъявленного параметра.
9	RECURSION	Не удается определить результат, так как в пакете содержится рекурсивная инструкция.
10	TEMPORARY_TABLE	Результат не удалось определить, так как пакет содержит временную таблицу и не поддерживается sp_describe_first_result_set .
11	UNSUPPORTED_STATEMENT	Не удалось определить результат, так как пакет содержит оператор, который не поддерживается sp_describe_first_result_set (например, FETCH, REVERT и т. д.).
12	OBJECT_TYPE_NOT_SUPPORTED	@object_id, переданный функции, не поддерживается (т. е. не хранимая процедура).
13	OBJECT_DOES_NOT_EXIST	@object_id, переданный функции, не найден в системном каталоге.

Разрешения

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

Примеры

Дополнительные примеры в разделе sp_describe_first_result_set (Transact-SQL) можно адаптировать для использования sys.dm_exec_describe_first_result_set.

О. Возврат сведений об отдельной инструкции Transact-SQL

Следующий код возвращает сведения о результатах инструкции 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. Возврат сведений о процедуре

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

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. Возврат метаданных из пакета, содержащего несколько инструкций

В следующем примере вычисляется пакет, содержащий две инструкции Transact-SQL. Результирующий набор описывает первый возвращенный результирующий набор.

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

См. также

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