sys.dm_sql_referenced_entities (Transact-SQL)

S’applique à : ouiSQL Server (toutes les versions prises en charge) OuiAzure SQL Database

Retourne une ligne pour chaque entité définie par l’utilisateur référencée par nom dans la définition de l’entité de référence spécifiée dans SQL Server . Une dépendance entre deux entités est créée lorsqu’une entité définie par l’utilisateur, appelée entité référencée, apparaît par nom dans une expression SQL rendue persistante d’une autre entité définie par l’utilisateur, appelée entité de référence. Par exemple, si une procédure stockée est l'entité de référence spécifiée, cette fonction retourne toutes les entités définies par l'utilisateur qui sont référencées dans la procédure stockée, telles que les tables, vues, types définis par l'utilisateur ou autres procédures stockées.

Vous pouvez utiliser cette fonction de gestion dynamique pour établir des rapports sur les types suivants d'entités référencées par l'entité de référence indiquée :

  • Entités liées au schéma

  • Entités non liées au schéma

  • Entités des bases de données croisées et entre serveurs

  • Dépendances au niveau des colonnes sur les entités liées au schéma et non liées au schéma

  • Types définis par l'utilisateur (alias et CLR)

  • Collections de schémas XML

  • Fonctions de partition

Syntaxe

sys.dm_sql_referenced_entities (  
    ' [ schema_name. ] referencing_entity_name ' ,
    ' <referencing_class> ' )  
  
<referencing_class> ::=  
{  
    OBJECT  
  | DATABASE_DDL_TRIGGER  
  | SERVER_DDL_TRIGGER  
}  

Arguments

[ schema_name. ] referencing_entity_name
Nom de l'entité de référence. schema_name est requis lorsque la classe de référence est Object.

schema_name. referencing_entity_name est de type nvarchar (517).

<referencing_class> :: = {Object | DATABASE_DDL_TRIGGER | SERVER_DDL_TRIGGER}
Classe de l'entité de référence spécifiée. Une seule classe peut être spécifiée par instruction.

<referencing_class> est de type nvarchar (60).

Table retournée

Nom de la colonne Type de données Description
referencing_minor_id int ID de colonne lorsque l'entité de référence est une colonne ; sinon 0. N'accepte pas la valeur NULL.
referenced_server_name sysname Nom du serveur de l'entité référencée.

Cette colonne est remplie pour les dépendances entre serveurs qui sont établies en spécifiant un nom en quatre parties valide. Pour plus d’informations sur les noms en plusieurs parties, consultez conventions de la syntaxe Transact-sql ()Transact-SQL .

NULL pour les dépendances non liées au schéma pour lesquelles l'entité a été référencée sans spécifier un nom en quatre parties.

NULL pour les entités liées au schéma, car elles doivent se trouver dans la même base de données et, par conséquent, ne peuvent être définies qu’à l’aide d’un nom en deux parties (Schema. Object).
referenced_database_name sysname Nom de la base de données de l'entité référencée.

Cette colonne est remplie pour les références des bases de données croisées et entre serveurs qui sont établies en spécifiant un nom en trois ou quatre parties valide.

NULL pour les références non liées au schéma en cas de spécification à l'aide d'un nom en une ou deux parties.

NULL pour les entités liées au schéma, car elles doivent se trouver dans la même base de données et, par conséquent, ne peuvent être définies qu’à l’aide d’un nom en deux parties (Schema. Object).
referenced_schema_name sysname Schéma auquel l'entité référencée appartient.

NULL pour les références non liées au schéma dans lesquelles l'entité a été référencée sans spécifier le nom de schéma.

Jamais NULL pour les références liées au schéma.
referenced_entity_name sysname Nom de l'entité référencée. N'accepte pas la valeur NULL.
referenced_minor_name sysname Nom de la colonne lorsque l'entité référencée est une colonne ; sinon NULL. Par exemple, referenced_minor_name est NULL dans la ligne qui répertorie l'entité référencée elle-même.

Une entité référencée est une colonne lorsqu'une colonne est identifiée par son nom dans l'entité de référence, ou lorsque l'entité parente est utilisée dans une instruction SELECT *.
referenced_id int ID de l'entité référencée. Lorsque referenced_minor_id n'est pas égal à 0, referenced_id est l'entité dans laquelle la colonne est définie.

Toujours NULL pour les références entre serveurs.

NULL pour les références des bases de données croisées lorsque l'ID ne peut pas être déterminé, car la base de données est hors connexion ou l'entité ne peut pas être liée.

NULL pour les références dans la base de données si l'ID ne peut pas être déterminé. Pour les références non liées au schéma, l’ID ne peut pas être résolu lorsque l’entité référencée n’existe pas dans la base de données ou lorsque la résolution de noms est dépendante de l’appelant. Dans ce dernier cas, is_caller_dependent a la valeur 1.

Jamais NULL pour les références liées au schéma.
referenced_minor_id int ID de colonne lorsque l'entité référencée est une colonne ; sinon 0. Par exemple, referenced_minor_name est 0 dans la ligne qui répertorie l'entité référencée elle-même.

Pour les références non liées au schéma, les dépendances de colonnes sont signalées uniquement lorsque toutes les entités référencées peuvent être liées. Si une entité référencée ne peut pas être liée, aucune dépendance au niveau des colonnes n'est signalée et referenced_minor_id est égal à 0. Voir l'exemple D.
referenced_class tinyint Classe de l'entité référencée.

1 = Objet ou colonne

6 = Type

10 = Collection du schéma XML

21 = Fonction de partition
referenced_class_desc nvarchar(60) Description de la classe de l'entité référencée.

OBJECT_OR_COLUMN

TYPE

XML_SCHEMA_COLLECTION

PARTITION_FUNCTION
is_caller_dependent bit Indique que la liaison de schéma pour l'entité référencée se produit au moment de l'exécution ; par conséquent, la résolution de l'ID d'entité dépend du schéma de l'appelant. Cela se produit lorsque l'entité référencée est une procédure stockée, procédure stockée étendue ou fonction définie par l'utilisateur appelée dans une instruction EXECUTE.

1 = l'entité référencée dépend de l'appelant et est résolue au moment de l'exécution. Dans ce cas, referenced_id a la valeur NULL.

0 = l'ID de l'entité référencée ne dépend pas de l'appelant. Toujours 0 pour les références liées au schéma et pour les références des bases de données croisées et entre serveurs qui spécifient explicitement un nom de schéma. Par exemple, une référence à une entité au format EXEC MyDatabase.MySchema.MyProc ne dépend pas de l'appelant. Toutefois, une référence au format EXEC MyDatabase..MyProc dépend de l'appelant.
is_ambiguous bit Indique que la référence est ambiguë et peut être résolue au moment de l’exécution en une fonction définie par l’utilisateur, un type défini par l’utilisateur (UDT) ou une référence XQuery à une colonne de type XML. Par exemple, supposez que l'instruction SELECT Sales.GetOrder() FROM Sales.MySales est définie dans une procédure stockée. Jusqu'à ce que la procédure stockée soit exécutée, il n'est pas possible de savoir si Sales.GetOrder() est une fonction définie par l'utilisateur dans le schéma Sales ou une colonne nommée Sales de type défini par l'utilisateur avec une méthode nommée GetOrder().

1 = la référence à une fonction définie par l'utilisateur ou méthode de type défini par l'utilisateur de colonne est ambiguë.

0 = la référence n'est pas équivoque ou l'entité peut être liée avec succès lorsque la fonction est appelée.

Toujours 0 pour les références liées au schéma.
is_selected bit 1 = L'objet ou la colonne est sélectionné.
is_updated bit 1 = L'objet ou la colonne est modifié.
is_select_all bit 1 = L'objet est utilisé dans une clause SELECT * (au niveau de l'objet uniquement).
is_all_columns_found bit 1 = Toutes les dépendances de colonne pour l'objet ont été trouvées.

0 = Les dépendances de colonne pour l'objet n'ont pas été trouvées.
is_insert_all bit 1 = l’objet est utilisé dans une instruction INSERT sans liste de colonnes (au niveau de l’objet uniquement).

Cette colonne a été ajoutée à SQL Server 2016.
is_incomplete bit 1 = l’objet ou la colonne a une erreur de liaison et est incomplet.

Cette colonne a été ajoutée à SQL Server 2016 SP2.
     

Exceptions

Retourne un jeu de résultats vide sous chacune des conditions suivantes :

  • Un objet système est spécifié.

  • L'entité spécifiée n'existe pas dans la base de données active.

  • L'entité spécifiée ne référence pas d'autres entités.

  • Un paramètre non valide est passé.

Retourne une erreur lorsque l'entité de référence spécifiée est une procédure stockée numérotée.

Retourne l'erreur 2020 lorsque des dépendances de colonnes ne peuvent pas être résolues. Cette erreur n'empêche pas la requête de retourner des dépendances au niveau objet.

Notes

Cette fonction peut être exécutée dans le contexte de n'importe quelle base de données pour retourner les entités qui référencent un déclencheur DDL au niveau du serveur.

Le tableau suivant répertorie les types des entités pour lesquelles les informations de dépendance sont créées et gérées. Les informations de dépendance ne sont pas créées ni gérées pour les règles, les valeurs par défaut, les tables temporaires, les procédures stockées temporaires ou les objets système.

Type d'entité Entité de référence Entité référencée
Table de charge de travail Oui* Oui
Affichage Oui Oui
Procédure stockée Transact-SQL** Oui Oui
Procédure stockée CLR Non Oui
Fonction Transact-SQL définie par l'utilisateur Oui Oui
Fonction CLR définie par l'utilisateur Non Oui
Déclencheur CLR (DML et DDL) Non Non
Déclencheur DML Transact-SQL Oui Non
Déclencheur DDL au niveau de la base de données Transact-SQL Oui Non
Déclencheur DDL au niveau du serveur Transact-SQL Oui Non
Procédures stockées étendues Non Oui
File d’attente Non Oui
Synonyme Non Oui
Type (alias et type CLR défini par l'utilisateur) Non Oui
Collection de schémas XML Non Oui
Fonction de partition Non Oui
     

* Une table est suivie en tant qu’entité de référence uniquement lorsqu’elle fait référence à un Transact-SQL module, un type défini par l’utilisateur ou une collection de schémas XML dans la définition d’une colonne calculée, d’une contrainte CHECK ou d’une contrainte default.

** Les procédures stockées numérotées avec une valeur entière supérieure à 1 ne sont pas suivies en tant qu'entité de référence ou référencée.

Autorisations

Requiert l'autorisation SELECT sur sys.dm_sql_referenced_entities et l'autorisation VIEW DEFINITION sur l'entité de référence. Par défaut, l'autorisation SELECT est accordée à public. Requiert l'autorisation VIEW DEFINITION sur la base de données ou l'autorisation ALTER DATABASE DDL TRIGGER sur la base de données lorsque l'entité de référence est un déclencheur DDL au niveau de la base de données. Requiert l'autorisation VIEW ANY DEFINITION sur le serveur lorsque l'entité de référence est un déclencheur DDL au niveau du serveur.

Exemples

R. Retourner les entités qui sont référencées par un déclencheur DDL au niveau de la base de données

L'exemple suivant retourne les entités (tables et colonnes) qui sont référencées par le déclencheur DDL au niveau de la base de données ddlDatabaseTriggerLog.

USE AdventureWorks2012;  
GO  
SELECT
        referenced_schema_name,
        referenced_entity_name,
        referenced_minor_name,
        referenced_minor_id,
        referenced_class_desc
    FROM
        sys.dm_sql_referenced_entities (
            'ddlDatabaseTriggerLog',
            'DATABASE_DDL_TRIGGER')
;
GO  

B. Retourner les entités qui sont référencées par un objet

L'exemple suivant retourne les entités qui sont référencées par la fonction définie par l'utilisateur dbo.ufnGetContactInformation.

USE AdventureWorks2012;  
GO  
SELECT
        referenced_schema_name,
        referenced_entity_name,
        referenced_minor_name,
        referenced_minor_id,
        referenced_class_desc,
        is_caller_dependent,
        is_ambiguous
    FROM
        sys.dm_sql_referenced_entities (
            'dbo.ufnGetContactInformation',
            'OBJECT')
;
GO  

C. Retourner les dépendances de colonne

L'exemple suivant crée la table Table1 avec la colonne calculée c définie comme étant la somme des colonnes a et b. La vue sys.dm_sql_referenced_entities est ensuite appelée. La vue retourne deux lignes, une pour chaque colonne définie dans la colonne calculée.

CREATE TABLE dbo.Table1 (a int, b int, c AS a + b);  
GO  
SELECT
        referenced_schema_name AS schema_name,  
        referenced_entity_name AS table_name,  
        referenced_minor_name  AS referenced_column,  
        COALESCE(
            COL_NAME(OBJECT_ID(N'dbo.Table1'),
            referencing_minor_id),
            'N/A') AS referencing_column_name  
    FROM
        sys.dm_sql_referenced_entities ('dbo.Table1', 'OBJECT')
;
GO

-- Remove the table.  
DROP TABLE dbo.Table1;  
GO  

Voici le jeu de résultats obtenu.

schema_name table_name referenced_column referencing_column  
----------- ---------- ----------------- ------------------  
dbo         Table1     a                 c  
dbo         Table1     b                 c  

D. Retour de dépendances de colonnes non liées au schéma

L'exemple suivant supprime Table1, puis crée Table2 et la procédure stockée Proc1. La procédure référence Table2 et la table Table1 inexistante. La vue sys.dm_sql_referenced_entities est exécutée avec la procédure stockée spécifiée comme entité de référence. Le jeu de résultats montre une ligne pour Table1 et 3 lignes pour Table2. Étant donné que Table1 n'existe pas, les dépendances de colonnes ne peuvent pas être résolues et l'erreur 2020 est retournée. La colonne is_all_columns_found retourne 0 pour Table1 indiquant qu'il y a des colonnes qui ne peuvent pas être découvertes.

DROP TABLE IF EXISTS dbo.Table1;
GO  
CREATE TABLE dbo.Table2 (c1 int, c2 int);  
GO  
CREATE PROCEDURE dbo.Proc1 AS  
    SELECT a, b, c FROM Table1;  
    SELECT c1, c2 FROM Table2;  
GO  
SELECT
        referenced_id,
        referenced_entity_name AS table_name,
        referenced_minor_name  AS referenced_column_name,
        is_all_columns_found
    FROM
        sys.dm_sql_referenced_entities ('dbo.Proc1', 'OBJECT');
GO  

Voici le jeu de résultats obtenu.

referenced_id table_name   referenced_column_name  is_all_columns_found  
------------- ------------ ----------------------- --------------------  
935674381     Table2       NULL                    1  
935674381     Table2       C1                      1  
935674381     Table2       C2                      1  
NULL          Table1       NULL                    0  

Msg 2020, Level 16, State 1, Line 1
The dependencies reported for entity "dbo.Proc1" might not include
 references to all columns. This is either because the entity
 references an object that does not exist or because of an error
 in one or more statements in the entity.  Before rerunning the
 query, ensure that there are no errors in the entity and that
 all objects referenced by the entity exist.

E. Illustration de la maintenance de dépendance dynamique

Cet exemple E suppose que l’exemple D a été exécuté. L’exemple E indique que les dépendances sont gérées dynamiquement. L’exemple effectue les opérations suivantes :

  1. Recrée Table1 , qui a été supprimée dans l’exemple D.
  2. Exécuter ensuite sys.dm_sql_referenced_entities est réexécutée avec la procédure stockée spécifiée comme entité de référence.

Le jeu de résultats montre que les deux tables et leurs colonnes respectives définies dans la procédure stockée sont retournées. En outre, la colonne is_all_columns_found retourne 1 pour tous les objets et colonnes.

CREATE TABLE Table1 (a int, b int, c AS a + b);  
GO   
SELECT
        referenced_id,
        referenced_entity_name AS table_name,
        referenced_minor_name  AS column_name,
        is_all_columns_found
    FROM
        sys.dm_sql_referenced_entities ('dbo.Proc1', 'OBJECT');
GO  
DROP TABLE Table1, Table2;  
DROP PROC Proc1;  
GO  

Voici le jeu de résultats obtenu.

referenced_id table_name   referenced_column_name  is_all_columns_found  
------------- ------------ ----------------------- --------------------  
935674381     Table2       NULL                    1 
935674381     Table2       c1                      1 
935674381     Table2       c2                      1 
967674495     Table1       NULL                    1 
967674495     Table1       a                       1  
967674495     Table1       b                       1  
967674495     Table1       c                       1  

F. Obtenir l'utilisation de l'objet ou de la colonne

L'exemple suivant permet d'obtenir les dépendances d'objet et de colonne de la procédure stockée HumanResources.uspUpdateEmployeePersonalInfo. Cette procédure met à jour les colonnes NationalIDNumber , BirthDate,``MaritalStatus et Gender de la Employee table en fonction d’une BusinessEntityID valeur spécifiée. Une autre procédure stockée, upsLogError est définie dans une tentative... CATCH pour capturer les erreurs d’exécution. Les colonnes is_selected, is_updated et is_select_all retournent des informations sur la façon dont ces objets et colonnes sont utilisés dans l'objet de référence. La table et les colonnes qui sont modifiées sont indiquées par un 1 dans la colonne is_updated. Seule la colonne BusinessEntityID est sélectionnée et la procédure stockée uspLogError n'est ni sélectionnée ni modifiée.

USE AdventureWorks2012;
GO
SELECT
        referenced_entity_name AS table_name,
        referenced_minor_name  AS column_name,
        is_selected,  is_updated,  is_select_all
    FROM
        sys.dm_sql_referenced_entities(
            'HumanResources.uspUpdateEmployeePersonalInfo',
            'OBJECT')
;

Voici le jeu de résultats obtenu.

table_name    column_name         is_selected is_updated is_select_all  
------------- ------------------- ----------- ---------- -------------  
uspLogError   NULL                0           0          0  
Employee      NULL                0           1          0  
Employee      BusinessEntityID    1           0          0  
Employee      NationalIDNumber    0           1          0  
Employee      BirthDate           0           1          0  
Employee      MaritalStatus       0           1          0  
Employee      Gender              0           1          0

Voir aussi

sys.dm_sql_referencing_entities (Transact-SQL)
sys.sql_expression_dependencies (Transact-SQL)