sys.dm_sql_referenced_entities (Transact-SQL)

適用対象: SQL Server Azure SQL Database Azure SQL Managed Instance

SQL Server で指定した参照元エンティティの定義で、名前によって参照されるユーザー定義エンティティごとに 1 行を返します。 2 つのエンティティ間の依存関係は、 参照エンティティと呼ばれる 1 つのユーザー定義エンティティが、 参照エンティティと呼ばれる別のユーザー定義エンティティの永続化された SQL 式に名前で表示されるときに作成されます。 たとえば、ストアド プロシージャが指定された参照元エンティティである場合、この関数は、テーブル、ビュー、ユーザー定義型 (UDT)、その他のストアド プロシージャなど、ストアド プロシージャで参照されるすべてのユーザー定義エンティティを返します。

この動的管理機能を使用すると、指定した参照元エンティティによって参照される次の種類のエンティティについてレポートできます。

• スキーマ バインド エンティティ

• スキーマ バインドされていないエンティティ

• データベース間エンティティとサーバー間エンティティ

• スキーマ バインドエンティティとスキーマバインドされていないエンティティに対する列レベルの依存関係

• ユーザー定義型 (エイリアスと CLR UDT)

• XML スキーマ コレクション

• パーティション関数

構文

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

引数

[ schema_name。 ] referencing_entity_name
参照元エンティティの名前です。 schema_name は、参照元のクラスが OBJECT の場合に必要です。

schema_name.referencing_entity_name は nvarchar(517)です。

<referencing_class> ::= { OBJECT |DATABASE_DDL_TRIGGER |SERVER_DDL_TRIGGER }
指定された参照元エンティティのクラスです。 ステートメントごとに指定できるクラスは 1 つだけです。

<referencing_class> は nvarchar(60)です。

返されるテーブル

例外

次のいずれかの条件に該当した場合は、空の結果セットが返されます。

• システム オブジェクトが指定されています。

• 指定したエンティティが現在のデータベースに存在しません。

• 指定されたエンティティは、どのエンティティも参照しません。

• 無効なパラメーターが渡される。

指定した参照元エンティティが番号付きストアド プロシージャである場合にエラーを返します。

列の依存関係を解決できない場合は、エラー 2020 を返します。 このエラーによって、クエリからオブジェクト レベルの依存関係が返されなくなることはありません。

解説

この関数は、任意のデータベースのコンテキストで実行して、サーバー レベルの DDL トリガーを参照するエンティティを返すことができます。

次の表に、依存関係情報を作成および管理するエンティティの種類を示します。 ルール、既定値、一時テーブル、一時ストアド プロシージャ、またはシステム オブジェクトに対しては、依存関係情報は作成または管理されません。

* テーブルが参照元エンティティとして追跡されるのは、計算列、CHECK 制約、または DEFAULT 制約の定義内で、Transact-SQL モジュール、ユーザー定義型、または XML スキーマ コレクションを参照する場合のみです。

** 1 より大きな整数値を持つ番号付きストアド プロシージャは、参照元エンティティとしても、参照先エンティティとしても追跡されません。

アクセス許可

sys.dm_sql_referenced_entities に対する SELECT 権限および参照元エンティティに対する VIEW DEFINITION 権限が必要です。 既定では、SELECT 権限が public に与えられます。 参照元エンティティがデータベース レベルの DDL トリガーである場合は、データベースに対する VIEW DEFINITION 権限またはデータベースに対する ALTER DATABASE DDL TRIGGER 権限が必要です。 参照元エンティティがサーバー レベルの DDL トリガーである場合は、サーバーに対する VIEW ANY DEFINITION 権限が必要です。

例

A. データベース レベルの DDL トリガーによって参照されるエンティティを返す

次の例では、データベース レベルの DDL トリガー ddlDatabaseTriggerLogによって参照されるエンティティ (テーブルと列) を返します。

USE AdventureWorks2022;  
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. オブジェクトによって参照されるエンティティを返します。

次の例では、ユーザー定義関数 dbo.ufnGetContactInformation によって参照されるエンティティを取得します。

USE AdventureWorks2022;  
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: 列の依存関係を返す

次の例では、計算列caとbの合計として定義されたテーブル Table1を作成します。 その後、sys.dm_sql_referenced_entities ビューが呼び出されます。 このビューは、2 つの行 (計算列で定義された各列につき 1 行) を返します。

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  

結果セットは次のとおりです。

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

D. スキーマバインドされていない列の依存関係を返す

次の例では、 Table1 を削除し、 Table2 とストアド プロシージャの Proc1を作成します。 プロシージャは、 Table2 と存在しないテーブル Table1を参照します。 ビュー sys.dm_sql_referenced_entities は、参照元エンティティとして指定されたストアド プロシージャで実行されます。 結果セットには、Table1 に対する 1 行と Table2 に対する 3 行があります。 Table1が存在しないため、列の依存関係を解決できず、エラー 2020 が返されます。 is_all_columns_found 列の Table1 に対する 0 は、検出できなかった列があることを示します。

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  

結果セットは次のとおりです。

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. 動的な依存関係のメンテナンスのデモンストレーション

この例 E では、例 D が実行されていることを前提としています。 例 E は、依存関係が動的に維持されることを示しています。 この例では、次のことを行います。

1. 例 D で削除された Table1を再作成します。
2. 次に実行 sys.dm_sql_referenced_entities は、参照元エンティティとして指定されたストアド プロシージャを使用して再度実行されます。

結果セットは、両方のテーブルと、ストアド プロシージャで定義されているそれぞれの列が返されることを示しています。 さらに、is_all_columns_found 列ではすべてのオブジェクトと列に 1 が返されます。

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  

結果セットは次のとおりです。

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. オブジェクトまたは列の使用法を返す

次の例では、ストアド プロシージャ HumanResources.uspUpdateEmployeePersonalInfo のオブジェクトと列の依存関係を返します。 この手順では、指定したBusinessEntityID値に基づいて、Employee テーブルの列NationalIDNumber、BirthDate,``MaritalStatus、およびGenderを更新します。 もう 1 つのストアド プロシージャ upsLogError TRY で定義されています。..CATCH ブロックを使用して、実行エラーをキャプチャします。 is_selected、is_updated、および is_select_all 列では、参照元オブジェクト内でのこれらのオブジェクトと列の使用方法についての情報が返されます。 変更されたテーブルと列は、is_updated列の 1 で示されます。 BusinessEntityID列は選択されているだけで、ストアド プロシージャuspLogErrorは選択も変更も行いません。

USE AdventureWorks2022;
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')
;

結果セットは次のとおりです。

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

参照

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