sys.dm_exec_describe_first_result_set_for_object (Transact-SQL)

Articolo
05/24/2023

Si applica a:SQL Server Database SQL di Azure Istanza gestita di SQL di Azure

Questa funzione a gestione dinamica accetta come @object_id parametro e descrive i primi metadati dei risultati per il modulo con tale ID. L'oggetto @object_id specificato può essere l'ID di una stored procedure Transact-SQL o un trigger Transact-SQL. Se è l'ID di qualsiasi altro oggetto, ad esempio una vista, una tabella, una funzione o una procedura CLR, viene specificato un errore nelle colonne degli errori del risultato.

sys.dm_exec_describe_first_result_set_for_object ha la stessa definizione del set di risultati di sys.dm_exec_describe_first_result_set (Transact-SQL) ed è simile a sp_describe_first_result_set (Transact-SQL).

Convenzioni di sintassi Transact-SQL

Sintassi

  
sys.dm_exec_describe_first_result_set_for_object   
    ( @object_id , @include_browse_information )

Argomenti

@object_id
Classe @object_id di una stored procedure Transact-SQL o di un trigger Transact-SQL. @object_id è di tipo int.

@include_browse_information
@include_browse_information è di tipo bit. Se impostato su 1, ogni query viene analizzata come se per essa fosse stata specificata un'opzione FOR BROWSE. Restituisce informazioni sulla tabella di origine e colonne chiave aggiuntive.

Tabella restituita

Questi metadati comuni vengono restituiti come set di risultati con una riga per ogni colonna nei metadati dei risultati. Ogni riga descrive il tipo e l'ammissione di valori Null della colonna nel formato descritto nella sezione seguente. Se la prima istruzione non esiste per ogni percorso di controllo, viene restituito un set di risultati con zero righe.

Nome colonna	Tipo di dati	Descrizione
is_hidden	bit	Specifica se la colonna è una colonna aggiuntiva inserita per informazioni di esplorazione che non compare effettivamente nel set di risultati.
column_ordinal	int	Contiene la posizione ordinale della colonna nel set di risultati. La posizione della prima colonna viene specificata come 1.
name	sysname	Contiene il nome della colonna se è possibile determinare un nome. In caso contrario, è NULL.
is_nullable	bit	Contiene il valore 1 se la colonna ammette valori Null, 0 se la colonna non ammette valori Null e 1 se non è possibile determinare se la colonna ammette valori Null.
system_type_id	int	Contiene la system_type_id del tipo di dati della colonna come specificato in sys.types. Per i tipi CLR, anche se la colonna system_type_name restituisce NULL, in questa colonna viene restituito il valore 240.
system_type_name	nvarchar(256)	Contiene il nome del tipo di dati. Include gli argomenti (quali lunghezza, precisione, scala) specificati per il tipo di dati della colonna. Se il tipo di dati è un tipo di alias definito dall'utente, il tipo di sistema sottostante viene specificato qui. Se è un tipo CLR definito dall'utente, in questa colonna viene restituito NULL.
max_length	smallint	Lunghezza massima in byte della colonna. -1 = Il tipo di dati della colonna è varchar(max), nvarchar(max), varbinary(max)o xml. Per le colonne di testo , il valore max_length sarà 16 o il valore impostato da sp_tableoption 'text in row'.
precision	tinyint	Precisione della colonna se basata su valori numerici. In caso contrario, restituisce 0.
scale	tinyint	Scala della colonna se basata su valori numerici. In caso contrario, restituisce 0.
collation_name	sysname	Nome delle regole di confronto della colonna se basata su caratteri. In caso contrario, viene restituito NULL.
user_type_id	int	Per i tipi di alias e CLR, contiene il valore user_type_id del tipo di dati della colonna come specificato in sys.types. In caso contrario, è NULL.
user_type_database	sysname	Per i tipi di alias e CLR, contiene il nome del database in cui è definito il tipo. In caso contrario, è NULL.
user_type_schema	sysname	Per i tipi di alias e CLR, contiene il nome dello schema in cui è definito il tipo. In caso contrario, è NULL.
user_type_name	sysname	Per i tipi di alias e CLR, contiene il nome del tipo. In caso contrario, è NULL.
assembly_qualified_type_name	nvarchar(4000)	Per i tipi CLR, restituisce il nome dell'assembly e la classe che definisce il tipo. In caso contrario, è NULL.
xml_collection_id	int	Contiene il valore xml_collection_id del tipo di dati della colonna come specificato in sys.columns. Questa colonna restituisce NULL se il tipo restituito non è associato a una raccolta XML Schema.
xml_collection_database	sysname	Contiene il database in cui viene definita la raccolta XML Schema associata a questo tipo. Questa colonna restituisce NULL se il tipo restituito non è associato a una raccolta XML Schema.
xml_collection_schema	sysname	Contiene lo schema in cui viene definita la raccolta XML Schema associata a questo tipo. Questa colonna restituisce NULL se il tipo restituito non è associato a una raccolta XML Schema.
xml_collection_name	sysname	Contiene il nome della raccolta XML Schema associata a questo tipo. Questa colonna restituisce NULL se il tipo restituito non è associato a una raccolta XML Schema.
is_xml_document	bit	Restituisce 1 se il tipo di dati restituito è XML ed è garantito che questo tipo sia un documento XML completo (incluso un nodo radice), contrariamente a un frammento XML. In caso contrario, restituisce 0.
is_case_sensitive	bit	Restituisce 1 se la colonna è di un tipo string che fa distinzione tra maiuscole e minuscole e 0 in caso contrario.
is_fixed_length_clr_type	bit	Restituisce 1 se la colonna è di un tipo CLR a lunghezza fissa e 0 in caso contrario.
source_server	sysname	Nome del server di origine restituito dalla colonna in questo risultato (se ha origine in un server remoto). Il nome viene assegnato come appare in sys.servers. Restituisce NULL se la colonna ha origine nel server locale o se non è possibile determinare in quale server ha origine. Viene popolata solo se sono richieste informazioni di esplorazione.
source_database	sysname	Nome del database di origine restituito dalla colonna in questo risultato. Restituisce NULL se non è possibile determinare il database. Viene popolata solo se sono richieste informazioni di esplorazione.
source_schema	sysname	Nome dello schema di origine restituito dalla colonna in questo risultato. Restituisce NULL se non è possibile determinare lo schema. Viene popolata solo se sono richieste informazioni di esplorazione.
source_table	sysname	Nome della tabella di origine restituita dalla colonna in questo risultato. Restituisce NULL se non è possibile determinare la tabella. Viene popolata solo se sono richieste informazioni di esplorazione.
source_column	sysname	Nome della colonna di origine restituita dalla colonna in questo risultato. Restituisce NULL se non è possibile determinare la colonna. Viene popolata solo se sono richieste informazioni di esplorazione.
is_identity_column	bit	Restituisce 1 se la colonna è una colonna Identity e 0 in caso contrario. Restituisce NULL se non è possibile determinare se la colonna è una colonna Identity.
is_part_of_unique_key	bit	Restituisce 1 se la colonna fa parte di un indice univoco (inclusi vincoli univoci e primari) e 0 in caso contrario. Restituisce NULL se non è possibile determinare se la colonna fa parte di un indice univoco. Viene popolata solo se sono richieste informazioni di esplorazione.
is_updateable	bit	Restituisce 1 se la colonna può essere aggiornata e 0 in caso contrario. Restituisce NULL se non è possibile determinare se la colonna può essere aggiornata.
is_computed_column	bit	Restituisce 1 se la colonna è una colonna calcolata e 0 in caso contrario. Restituisce NULL se non è possibile determinare se la colonna è una colonna calcolata.
is_sparse_column_set	bit	Restituisce 1 se la colonna è una colonna di tipo sparse e 0 in caso contrario. Restituisce NULL se non è possibile determinare se la colonna fa parte di un set di colonne di tipo sparse.
ordinal_in_order_by_list	smallint	Posizione di questa colonna nell'elenco ORDER BY. Restituisce NULL se la colonna non compare nell'elenco ORDER BY o se l'elenco ORDER BY non può essere determinato in modo univoco.
order_by_list_length	smallint	Lunghezza dell'elenco ORDER BY. Restituisce NULL se non è presente alcun elenco ORDER BY o se l'elenco ORDER BY non può essere determinato in modo univoco. Si noti che questo valore sarà lo stesso per tutte le righe restituite da sp_describe_first_result_set.
order_by_is_descending	smallint NULL	Se il ordinal_in_order_by_list non è NULL, la colonna order_by_is_descending indica la direzione della clausola ORDER BY per questa colonna. In caso contrario, viene restituito NULL.
error_number	int	Contiene il numero dell'errore restituito dalla funzione. Contiene NULL se non si è verificato alcun errore nella colonna.
error_severity	int	Contiene la gravità restituita dalla funzione. Contiene NULL se non si è verificato alcun errore nella colonna.
error_state	int	Contiene il messaggio sullo stato attuale restituito dalla funzione. Se non si sono verificati errori. la colonna conterrà NULL.
error_message	nvarchar(4096)	Contiene il messaggio restituito dalla funzione. La colonna contiene NULL se non si è verificato alcun errore.
error_type	int	Contiene un numero intero che rappresenta l'errore restituito. Viene eseguito il mapping a error_type_desc. Vedere l'elenco nelle osservazioni.
error_type_desc	nvarchar(60)	Contiene una breve stringa in caratteri maiuscoli che rappresenta l'errore restituito. Viene eseguito il mapping a error_type. Vedere l'elenco nelle osservazioni.

Osservazioni:

Questa funzione usa lo stesso algoritmo di sp_describe_first_result_set. Per altre informazioni, vedere sp_describe_first_result_set (Transact-SQL).

Nella tabella seguente vengono elencati i tipi di errore con le relative descrizioni

error_type	error_type	Descrizione
1	VARIE	Tutti gli errori che non sono stati descritti.
2	SYNTAX	Errore di sintassi nel batch.
3	CONFLICTING_RESULTS	Impossibile determinare il risultato a causa di un conflitto tra due possibili prime istruzioni.
4	DYNAMIC_SQL	Impossibile determinare il risultato perché codice SQL dinamico potrebbe potenzialmente restituire il primo risultato.
5	CLR_PROCEDURE	Impossibile determinare il risultato perché una stored procedure CLR potrebbe potenzialmente restituire il primo risultato.
6	CLR_TRIGGER	Impossibile determinare il risultato perché un trigger CLR potrebbe potenzialmente restituire il primo risultato.
7	EXTENDED_PROCEDURE	Impossibile determinare il risultato perché una stored procedure estesa potrebbe potenzialmente restituire il primo risultato.
8	UNDECLARED_PARAMETER	Impossibile determinare il risultato perché il tipo di dati di una o più colonne del set di risultati dipende potenzialmente da un parametro non dichiarato.
9	RECURSION	Non è stato possibile determinare il risultato perché il batch contiene un'istruzione ricorsiva.
10	TEMPORARY_TABLE	Impossibile determinare il risultato perché il batch contiene una tabella temporanea e non è supportato da sp_describe_first_result_set .
11	UNSUPPORTED_STATEMENT	Impossibile determinare il risultato perché il batch contiene un'istruzione non supportata da sp_describe_first_result_set (ad esempio, FETCH, REVERT e così via).
12	OBJECT_ID_NOT_SUPPORTED	L'oggetto @object_id passato alla funzione non è supportato (ad esempio, non una stored procedure)
13	OBJECT_ID_DOES_NOT_EXIST	L'oggetto @object_id passato alla funzione non è stato trovato nel catalogo di sistema.

Autorizzazioni

Richiede l'autorizzazione per eseguire l'argomento @tsql .

Esempi

R. Restituzione di metadati con e senza informazioni di esplorazione

Nell'esempio seguente viene creata una stored procedure denominata TestProc2 che restituisce due set di risultati. Nell'esempio viene quindi illustrato che sys.dm_exec_describe_first_result_set restituisce informazioni sul primo set di risultati nella routine, con e senza le informazioni di esplorazione.

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. Combinazione della funzione sys.dm_exec_describe_first_result_set_for_object e di una tabella o vista

Nell'esempio seguente vengono utilizzate sia la vista del catalogo di sistema sys.procedures che la funzione sys.dm_exec_describe_first_result_set_for_object per visualizzare i metadati per i set di risultati di tutte le stored procedure nel AdventureWorks2022 database.

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

Vedi anche

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