分享方式:


sys.dm_exec_describe_first_result_set_for_object (Transact-SQL)

適用於:SQL ServerAzure SQL 資料庫 Azure SQL 受控執行個體

此動態管理函式會採用 @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 性。 如果每個控件路徑沒有第一個語句,則會傳回含有零個數據列的結果集。

資料行名稱 資料類型 描述
is_hidden bit 指定數據行是否為為了瀏覽資訊而新增的額外數據行,而不會實際出現在結果集中。
column_ordinal int 包含結果集中數據行的序數位置。 第一個數據行的位置會指定為 1。
name sysname 如果可以判斷名稱,則包含數據行的名稱。 否則為 NULL。
is_nullable bit 如果數據行允許 NULL,則包含值 1;如果數據行不允許 NUL,則為 0;如果無法判斷數據行允許 NUL,則為 1。
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,或是sp_tableoption 「數據列中的文字」所設定的值。
有效位數 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 中所指定。 如果傳回的類型與 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 雜項 未描述的所有錯誤。
2 語法 批次中發生語法錯誤。
3 CONFLICTING_RESULTS 無法判斷結果,因為兩個可能的第一個語句之間發生衝突。
4 DYNAMIC_SQL 無法判斷結果,因為可能會傳回第一個結果的動態 SQL。
5 CLR_PROCEDURE 無法判斷結果,因為 CLR 預存程式可能會傳回第一個結果。
6 CLR_TRIGGER 無法判斷結果,因為CLR觸發程式可能會傳回第一個結果。
7 EXTENDED_PROCEDURE 無法判斷結果,因為擴充預存程式可能會傳回第一個結果。
8 UNDECLARED_PARAMETER 無法判斷結果,因為一或多個結果集數據行的數據類型可能相依於未宣告的參數。
9 遞歸 無法判斷結果,因為批次包含遞歸語句。
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)