sys.dm_exec_describe_first_result_set_for_object (Transact-SQL)
适用于：
SQL Server Azure SQL 数据库 Azure SQL 托管实例
此动态管理函数采用 @object_id 参数并描述具有该 ID 的模块的第一个结果元数据。 指定 @object_id 可以是 Transact-SQL 存储过程或 Transact-SQL 触发器的 ID。 如果它是其他任何对象（如视图、表、函数或 CLR 过程）的 ID，则会在结果的错误列中指定错误。
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）。
语法
sys.dm_exec_describe_first_result_set_for_object
( @object_id , @include_browse_information )
参数
@object_id
@object_id Transact-SQL 存储过程或 Transact-SQL 触发器。 的类型为 int@object_id。
@include_browse_information
@include_browse_information 是类型 位。 如果设置为 1，则分析每个查询，就好像它在查询中使用 FOR BROWSE 选项。 返回其他键列和源表信息。
返回的表
此公共元数据作为结果集返回，结果元数据中的每列对应于一行。 每一行以下面一节所说明的格式描述列的类型和为 Null 性。 如果对于每个控制路径不存在第一个语句，则返回的结果集不包含任何行。
| 列名称 | 数据类型 | 说明 |
|---|---|---|
| is_hidden | bit | 指定列是否是出于浏览信息的目的而额外添加的，并不会实际出现在结果集中。 |
| column_ordinal | int | 在结果集中包含列的序号位置。 第一列的位置将指定为 1。 |
| name | sysname | 包含列的名称（如果可以确定名称）。 否则为 NULL。 |
| is_nullable | bit | 如果列允许 NUL，则包含值 1;如果列不允许 NUL，则为 0;如果无法确定列允许 NUL，则包含 1。 |
| system_type_id | int | 包含在 sys.types 中指定的列数据类型的 system_type_id。 对于 CLR 类型，即使 system_type_name 列返回 NULL，该列也会返回值 240。 |
| system_type_name | nvarchar(256) | 包含数据类型名称。 包含为列数据类型指定的参数（例如，length、precision、scale）。 如果数据类型是用户定义的别名类型，则会在此处指定基本系统类型。 如果数据类型是 CLR 用户定义类型，则在此列中返回 NULL。 |
| max_length | smallint | 列的最大长度（字节）。 -1 = 列数据类型是 varchar(max)、nvarchar(max)、varbinary(max) 或 xml。 对于文本列，max_length 值将是 16 或是由 sp_tableoption“text in row”设置的值。 |
| 精度 | tinyint | 如果为基于数值的列，则为该列的精度。 否则，返回 0。 |
| scale | tinyint | 如果基于数值，则为列的小数位数。 否则，返回 0。 |
| collation_name | sysname | 如果列包含的是字符，则为该列的排序规则的名称。 否则，返回 NULL。 |
| user_type_id | int | 对于 CLR 和别名类型，包含在 sys.types 中指定的列数据类型的 user_type_id。 否则为 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 | 包含 sys.columns 中指定的列数据类型的 xml_collection_id。 如果返回的类型与 XML 架构集合不关联，则该列将返回 NULL。 |
| xml_collection_database | sysname | 包含定义与此类型关联的 XML 架构集合的数据库。 如果返回的类型与 XML 架构集合不关联，则该列将返回 NULL。 |
| xml_collection_schema | sysname | 包含定义与此类型关联的 XML 架构集合的架构。 如果返回的类型与 XML 架构集合不关联，则该列将返回 NULL。 |
| xml_collection_name | sysname | 包含与此类型关联的 XML 架构集合的名称。 如果返回的类型与 XML 架构集合不关联，则该列将返回 NULL。 |
| is_xml_document | bit | 如果返回的数据类型为 XML，并且保证该类型是完整的 XML 文档（包含根节点，与 XML 片段相对），则返回 1。 否则，返回 0。 |
| is_case_sensitive | bit | 如果列为区分大小写的字符串类型，则返回 1；否则，返回 0。 |
| is_fixed_length_clr_type | bit | 如果列为固定长度 CLR 类型，则返回 1；否则，返回 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 列表中的位置：如果在 ORDER BY 列表中不显示该列或无法唯一确定 ORDER BY 列表，则返回 NULL。 |
| order_by_list_length | smallint | ORDER BY 列表的长度。 如果没有 ORDER BY 列表，或者无法唯一确定 ORDER BY 列表，则返回 NULL。 请注意，对于 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 | 说明 |
|---|---|---|
| 1 | MISC | 未描述的所有错误。 |
| 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_ID_NOT_SUPPORTED | @object_id不支持传递给函数（即不是存储过程） |
| 13 | OBJECT_ID_DOES_NOT_EXIST | @object_id在系统目录中找不到传递给函数的函数。 |
权限
需要权限才能执行 @tsql 参数。
示例
A. 返回包含和不含浏览信息的元数据
以下示例创建一个名为 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)