Функция динамического управления sys.dm_sql_referenced_entities (Transact-SQL)sys.dm_sql_referenced_entities (Transact-SQL)

• 05/01/2019
• Чтение занимает 9 мин
• • 
  • 

Применимо к:Applies to: SQL ServerSQL Server (все поддерживаемые версии)SQL ServerSQL Server (all supported versions) База данных SQL AzureAzure SQL DatabaseБаза данных SQL AzureAzure SQL DatabaseПрименимо к:Applies to: SQL ServerSQL Server (все поддерживаемые версии)SQL ServerSQL Server (all supported versions) База данных SQL AzureAzure SQL DatabaseБаза данных SQL AzureAzure SQL Database

Возвращает по одной строке для каждой определяемой пользователем сущности, на которую ссылается имя в определении указанной ссылающейся сущности в SQL ServerSQL Server .Returns one row for each user-defined entity that is referenced by name in the definition of the specified referencing entity in SQL ServerSQL Server. Зависимость между двумя сущностями создается, когда одна определяемая пользователем сущность, называемая упоминаемой сущностью, отображается по имени в сохраненном выражении SQL другой определяемой пользователем сущности, называемой ссылающейся сущностью.A dependency between two entities is created when one user-defined entity, called the referenced entity, appears by name in a persisted SQL expression of another user-defined entity, called the referencing entity. Например, если в качестве ссылающейся сущности выступает хранимая процедура, то данная функция выводит список всех определяемых пользователем сущностей, упоминаемых в данной хранимой процедуре. К упоминаемым определяемым пользователем сущностям относятся: таблицы, представления, определяемые пользователем типы (UDT), а также другие хранимые процедуры.For example, if a stored procedure is the specified referencing entity, this function returns all user-defined entities that are referenced in the stored procedure such as tables, views, user-defined types (UDTs), or other stored procedures.

Данная функция динамического управления может быть использована для отображения списка сущностей, упоминаемых заданной ссылающейся сущностью и имеющих следующие типы:You can use this dynamic management function to report on the following types of entities referenced by the specified referencing entity:

• сущности, привязанные к схеме;Schema-bound entities

• несвязанные сущности;Non-schema-bound entities

• межбазовые и межсерверные сущности;Cross-database and cross-server entities

• зависимости уровня столбца, как связанные, так и не связанные со схемами;Column-level dependencies on schema-bound and non-schema-bound entities

• определяемые пользователем типы (псевдонимы и типы CLR);User-defined types (alias and CLR UDT)

• коллекции XML-схемXML schema collections

• функции секционированияPartition functions

СинтаксисSyntax

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

АргументыArguments

[ schema_name.[ schema_name. ] referencing_entity_name] referencing_entity_name
Имя ссылающейся сущности.Is the name of the referencing entity. schema_name является обязательным, если ссылающийся класс является объектом.schema_name is required when the referencing class is OBJECT.

schema_name. referencing_entity_name имеет тип nvarchar (517).schema_name.referencing_entity_name is nvarchar(517).

<referencing_class> :: = {Object | DATABASE_DDL_TRIGGER | SERVER_DDL_TRIGGER}<referencing_class> ::= { OBJECT | DATABASE_DDL_TRIGGER | SERVER_DDL_TRIGGER }
Класс заданной ссылающейся сущности.Is the class of the specified referencing entity. В одной инструкции может быть указан только один класс.Only one class can be specified per statement.

<referencing_class> имеет тип nvarchar (60).<referencing_class> is nvarchar(60).

Возвращаемая таблицаTable Returned

ИсключенияExceptions

Возвращает пустой результирующий набор, если выполняется любое из следующих условий.Returns an empty result set under any of the following conditions:

• Указан системный объект.A system object is specified.

• Указанная сущность не существует в текущей базе данных.The specified entity does not exist in the current database.

• Указанная сущность не ссылается ни на какие сущности.The specified entity does not reference any entities.

• Передан недопустимый параметр.An invalid parameter is passed.

Выдает ошибку, если заданная ссылающаяся сущность является пронумерованной хранимой процедурой.Returns an error when the specified referencing entity is a numbered stored procedure.

Возвращает ошибку 2020, когда не удается разрешить зависимости столбца.Returns error 2020 when column dependencies cannot be resolved. Эта ошибка не препятствует возврату запросом зависимостей на уровне объектов.This error does not prevent the query from returning object-level dependencies.

ПримечанияRemarks

Данная функция может выполняться в контексте любой базы данных и осуществляет отображение списка сущностей, ссылающихся на триггер DDL уровня сервера.This function can be executed in the context of the any database to return the entities that reference a server-level DDL trigger.

В следующей таблице перечислены типы сущностей, для которых созданы и обновляются данные о зависимостях.The following table lists the types of entities for which dependency information is created and maintained. Данные о зависимостях не создаются и не обновляются для правил, значений по умолчанию, временных таблиц, временных хранимых процедур и системных объектов.Dependency information is not created or maintained for rules, defaults, temporary tables, temporary stored procedures, or system objects.

*Таблица обрабатывается как ссылающаяся сущность, только если она ссылается на Transact-SQLTransact-SQL модуль, определяемый пользователем тип или коллекцию схем XML в определении вычисляемого столбца, проверочного ограничения или ограничения по умолчанию.* A table is tracked as a referencing entity only when it references a Transact-SQLTransact-SQL module, user-defined type, or XML schema collection in the definition of a computed column, CHECK constraint, or DEFAULT constraint.

** Пронумерованные хранимые процедуры с целочисленным значением больше 1 не отслеживаются в качестве ссылающихся или упоминаемых сущностей.** Numbered stored procedures with an integer value greater than 1 are not tracked as either a referencing or referenced entity.

РазрешенияPermissions

Требует разрешения SELECT для функции sys.dm_sql_referenced_entities и разрешения VIEW DEFINITION для ссылающейся сущности.Requires SELECT permission on sys.dm_sql_referenced_entities and VIEW DEFINITION permission on the referencing entity. Разрешение SELECT по умолчанию предоставляется роли public.By default, SELECT permission is granted to public. Требует разрешения VIEW DEFINITION для базы данных, либо, если ссылающаяся сущность является триггером DDL уровня базы данных, разрешения ALTER DATABASE DDL TRIGGER.Requires VIEW DEFINITION permission on the database or ALTER DATABASE DDL TRIGGER permission on the database when the referencing entity is a database-level DDL trigger. Если указанный модуль является триггером DDL уровня сервера, то требуется разрешение VIEW ANY DEFINITION на уровне сервера.Requires VIEW ANY DEFINITION permission on the server when the referencing entity is a server-level DDL trigger.

ПримерыExamples

A.A. Возврат сущностей, на которые ссылается триггер DDL уровня базы данныхReturn entities that are referenced by a database-level DDL trigger

В ходе выполнения следующего примера производится отображение списка сущностей (таблиц и столбцов), упоминаемых триггером DDL уровня базы данных ddlDatabaseTriggerLog.The following example returns the entities (tables and columns) that are referenced by the database-level DDL trigger 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. Возврат сущностей, на которые ссылается объектReturn entities that are referenced by an object

В ходе выполнения следующего примера производится отображение списка сущностей, упоминаемых в определяемой пользователем функции dbo.ufnGetContactInformation.The following example returns the entities that are referenced by the user-defined function 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. Возврат зависимостей столбцовReturn column dependencies

В ходе выполнения представленного ниже примера осуществляется создание таблицы Table1, в которой содержится вычисляемый столбец c, определяемый как сумма столбцов a и b.The following example creates the table Table1 with the computed column c defined as the sum of columns a and b. Затем производится вызов представления sys.dm_sql_referenced_entities.The sys.dm_sql_referenced_entities view is then called. Представление содержит две строки, по одной для каждого столбца, определенного в вычисляемом столбце.The view returns two rows, one for each column defined in the computed column.

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  

Результирующий набор:Here is the result set.

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

Г.D. Возврат списка зависимостей столбцов, не привязанных к схемеReturning non-schema-bound column dependencies

В ходе выполнения представленного ниже примера выполняется удаление таблицы Table1, а также создание таблицы Table2 и хранимой процедуры Proc1.The following example drops Table1 and creates Table2 and stored procedure Proc1. Процедура ссылается на таблицу Table2 и на несуществующую таблицу Table1.The procedure references Table2 and the nonexistent table Table1. Представление sys.dm_sql_referenced_entities запускается с помощью хранимой процедуры, которая указана в качестве ссылающейся сущности.The view sys.dm_sql_referenced_entities is run with the stored procedure specified as the referencing entity. В результирующем наборе показана одна строка для таблицы Table1 и 3 строки для таблицы Table2.The result set shows one row for Table1 and 3 rows for Table2. Поскольку таблица Table1 не существует, то не удается разрешить зависимости столбца и возвращается ошибка 2020.Because Table1 does not exist, the column dependencies cannot be resolved and error 2020 is returned. Столбец is_all_columns_found возвращает 0 для таблицы Table1, указывая, что существуют столбцы, которые не удалось обнаружить.The is_all_columns_found column returns 0 for Table1 indicating that there were columns that could not be discovered.

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  

Результирующий набор:Here is the result set.

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. Отображение параметров обслуживания динамических зависимостейDemonstrating dynamic dependency maintenance

В этом примере E предполагается, что был запущен пример г.This Example E assumes that Example D has been run. В примере E показано, что зависимости поддерживаются динамически.Example E shows that dependencies are maintained dynamically. Пример выполняет следующие действия:The example does the following things:

1. Повторно создает Table1 , что было пропущено в примере г.Re-creates Table1, which was dropped in Example D.
2. Затем запустите sys.dm_sql_referenced_entities повторно, выполнив хранимую процедуру, указанную в качестве ссылающейся сущности.Run Then sys.dm_sql_referenced_entities is run again with the stored procedure specified as the referencing entity.

Результирующий набор показывает, что возвращаются обе таблицы и соответствующие им столбцы, определенные в хранимой процедуре.The result set shows that both tables, and their respective columns defined in the stored procedure, are returned. Кроме того, столбец is_all_columns_found возвращает значение 1 для всех объектов и столбцов.In addition, the is_all_columns_found column returns a 1 for all objects and columns.

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  

Результирующий набор:Here is the result set.

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. Использование возвращения объекта или столбцаReturning object or column usage

В следующем примере возвращаются зависимости объекта и столбца хранимой процедуры HumanResources.uspUpdateEmployeePersonalInfo.The following example returns the objects and column dependencies of the stored procedure HumanResources.uspUpdateEmployeePersonalInfo. Эта процедура обновляет столбцы NationalIDNumber , BirthDate,``MaritalStatus и Gender Employee таблицы на основе указанного BusinessEntityID значения.This procedure updates the columns NationalIDNumber, BirthDate,``MaritalStatus, and Gender of the Employee table based on a specified BusinessEntityID value. Другая хранимая процедура, upsLogError определенная в инструкции try... CATCH для записи всех ошибок выполнения.Another stored procedure, upsLogError is defined in a TRY...CATCH block to capture any execution errors. Столбцы is_selected, is_updated и is_select_all возвращают сведения о способе использования этих объектов и столбцов в рамках ссылающегося объекта.The is_selected, is_updated, and is_select_all columns return information about how these objects and columns are used within the referencing object. Измененная таблица и столбцы в обновленном столбце помечаются единицей.The table and columns that are modified are indicated by a 1 in the is_updated column. Единственный выбранный столбец — BusinessEntityID, а хранимая процедура uspLogError не выбрана и не изменена.The BusinessEntityID column is only selected and the stored procedure uspLogError is neither selected nor modified.

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

Результирующий набор:Here is the result set.

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

См. такжеSee Also

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