CREATE EVENT NOTIFICATION (Transact-SQL)

Применимо к:SQL Server Управляемый экземпляр SQL Azure

Создает объект, отправляющий в службу компонента Service Broker данные о событии сервера или базы данных. Уведомления о событиях создаются только при помощи инструкций Transact-SQL.

Соглашения о синтаксисе Transact-SQL

Синтаксис

CREATE EVENT NOTIFICATION event_notification_name   
ON { SERVER | DATABASE | QUEUE queue_name }   
[ WITH FAN_IN ]  
FOR { event_type | event_group } [ ,...n ]  
TO SERVICE 'broker_service' , { 'broker_instance_specifier' | 'current database' }  
[ ; ]  

Примечание.

Сведения о синтаксисе Transact-SQL для SQL Server 2014 (12.x) и более ранних версиях см . в документации по предыдущим версиям.

Аргументы

event_notification_name
Имя уведомления о событии. Имя уведомления о событии должно соответствовать правилам для идентификаторов, и оно должно быть уникальным в той области, где они были созданы: SERVER, DATABASE или object_name.

СЕРВЕР
Применяет область уведомления о событии к текущему экземпляру SQL Server. Если задано это значение, уведомление срабатывает при каждом возникновении события, указанного в предложении FOR, на экземпляре SQL Server.

Примечание.

Этот параметр недоступен в автономной базе данных.

DATABASE
Применяет область уведомления о событии к текущей базе данных. Если задано это значение, уведомление срабатывает при каждом возникновении в текущей базе данных события, указанного в предложении FOR.

ОЧЕРЕДЬ
Применяет область уведомления о событии к определенной очереди в текущей базе данных. Параметр QUEUE можно указать, только если также указан параметр FOR QUEUE_ACTIVATION или FOR BROKER_QUEUE_DISABLED.

queue_name
Имя очереди, к которой применяется уведомление о событии. Аргумент queue_name можно указать, только если задан параметр QUEUE.

WITH FAN_IN
Служит для SQL Server указанием рассылать обозначенным службам только одно сообщение на событие для всех уведомлений о событиях, которые:

  • созданы в том же событии;

  • созданы тем же участником (который определен таким же идентификатором безопасности);

  • указывают ту же службу и broker_instance_specifier;

  • указывают WITH FAN_IN.

Например, были созданы три уведомления о событии. Все уведомления о событии указывают параметры FOR ALTER_TABLE, WITH FAN_IN, предложение TO SERVICE и созданы тем же идентификатором безопасности. При выполнении инструкции ALTER TABLE сообщения, которые созданы этими тремя уведомлениями о событии, объединяются в одно. Поэтому целевая служба получает только одно сообщение о событии.

event_type
Имя типа события, которое вызывает уведомление о событии. Аргумент event_type может быть типом события DDL Transact-SQL, трассировки SQL или типом события Service Broker. Список подходящих типов событий DDL Transact-SQL см. в разделе DDL-события. QUEUE_ACTIVATION и BROKER_QUEUE_DISABLED являются типами событий Service Broker. Дополнительные сведения см. в разделе Event Notifications.

event_group
Имя предопределенной группы типов событий Transact-SQL или трассировки SQL. Возникновение любого события из группы может привести к срабатыванию уведомления о событии. Список групп DDL-событий, содержащихся в них событий Transact-SQL и область их определения см. в разделе Группы DDL-событий.

Аргумент event_group также выполняет функцию макроса, добавляя входящие в него типы событий к представлению каталога sys.events после завершения инструкции CREATE EVENT NOTIFICATION.

'broker_service'
Указывает целевую службу, получающую данные о событиях экземпляра. SQL Server начинает один или несколько диалогов с целевой службой для уведомления о событии. Данная служба должна поддерживать тип сообщений о событиях SQL Server и контракт, использованный для отправки сообщения.

Диалог остается открытым до удаления уведомления о событии. Некоторые ошибки могут привести к досрочному завершению диалогов. Явное завершение всех или некоторых диалогов может помешать конечной службе получать новые сообщения.

{ 'broker_instance_specifier' | 'current database' }
Указывает экземпляр компонента Service Broker, на котором выполняется broker_service. Значение для определенного компонента Service Broker может быть получено путем запроса столбца service_broker_guid представления каталога sys.databases. Чтобы указать экземпляр компонента Service Broker в текущей базе данных, используйте 'current database'. 'current database' — это нечувствительный к регистру строковый литерал.

Примечание.

Этот параметр недоступен в автономной базе данных.

Замечания

Service Broker включает в себя тип сообщений и контракт исключительно для уведомлений о событии. Таким образом, необязательно создавать службу, которая запускает компонент Service Broker, поскольку она уже существует и указывает следующее имя контракта: https://schemas.microsoft.com/SQL/Notifications/PostEventNotification.

Целевая служба, принимающая уведомления о событиях, должна поддерживать такой уже существующий контракт.

Важно!

Безопасность диалогового окна Service Broker должна быть настроена для уведомлений о событиях, отправляющих сообщения в брокер служб на удаленном сервере. Безопасность диалога должна быть настроена вручную согласно модели полной безопасности. Дополнительные сведения см. в разделе Настройка безопасности диалогов для уведомлений о событиях.

Если происходит откат транзакции события, активирующей уведомление, то же происходит и с отправкой уведомления о событии. Уведомления о событиях не срабатывают в результате действий, определенных триггерами, когда происходит завершение или откат транзакции внутри триггера. Учитывая то, что события трассировки не связаны транзакциями, уведомления о событиях, основанные на событиях трассировки, отправляются вне зависимости от того, происходит ли откат активировавшей их транзакции.

Если диалог между сервером и конечной службой прерывается после срабатывания уведомления о событии, то появляется сообщение об ошибке, а уведомление о событии удаляется.

На транзакцию события, инициировавшую уведомление, не влияет успешность отправки уведомления о событии.

Все неудачные попытки отправки уведомления о событии заносятся в журнал.

Разрешения

Чтобы создать уведомление о событии в области базы данных (ON DATABASE), необходимо разрешение CREATE DATABASE DDL EVENT NOTIFICATION в текущей базе данных.

Чтобы создать уведомление о событии для инструкции DDL в области сервера (ON SERVER), необходимо разрешение CREATE DDL EVENT NOTIFICATION на сервере.

Чтобы создать уведомление о событии для события трассировки, необходимо разрешение CREATE TRACE EVENT NOTIFICATION на сервере.

Чтобы создать уведомление о событии в области очереди, необходимо разрешение ALTER для запроса.

Примеры

Примечание.

В примерах A и B, идентификатор GUID, указанный в предложении TO SERVICE 'NotifyService' («8140a771-3c4b-4479-8ac0-81008ab17984») специфичен для компьютера, на котором установлен пример. Например, это guid для базы данных AdventureWorks2022.

Чтобы копировать и запустить эти примеры, необходимо заменить этот идентификатор GUID на идентификатор из вашего компьютера и экземпляра SQL Server. Как объясняется выше в разделе "Аргументы", 'broker_instance_specifier' можно получить с помощью запроса к столбцу service_broker_guid представления каталога sys.databases.

А. Создание уведомления о событии уровня сервера

В следующем примере создаются объекты, необходимые для установки целевой службы при помощи Service Broker. Конечная служба ссылается на тип сообщения и контракт вызывающей стороны исключительно для уведомлений о событиях. Затем уведомление о событии создается в конечной службе, которая начинает рассылку уведомлений в ответ на событие трассировки Object_Created на экземпляре SQL Server.

--Create a queue to receive messages.  
CREATE QUEUE NotifyQueue ;  
GO  

--Create a service on the queue that references  
--the event notifications contract.  
CREATE SERVICE NotifyService  
ON QUEUE NotifyQueue  
([https://schemas.microsoft.com/SQL/Notifications/PostEventNotification]);  
GO  

--Create a route on the service to define the address   
--to which Service Broker sends messages for the service.  
CREATE ROUTE NotifyRoute  
WITH SERVICE_NAME = 'NotifyService',  
ADDRESS = 'LOCAL';  
GO 

--Create the event notification.  
CREATE EVENT NOTIFICATION log_ddl1   
ON SERVER   
FOR Object_Created   
TO SERVICE 'NotifyService',  
    '8140a771-3c4b-4479-8ac0-81008ab17984' ;  

B. Создание уведомления о событии уровня базы данных

В следующем примере создается уведомление о событии для той же службы, что и в предыдущем примере. Уведомление о событии запускается после ALTER_TABLE возникновения события в примере базы данных AdventureWorks2022.

CREATE EVENT NOTIFICATION Notify_ALTER_T1  
ON DATABASE  
FOR ALTER_TABLE  
TO SERVICE 'NotifyService',  
    '8140a771-3c4b-4479-8ac0-81008ab17984';  

C. Получение данных об уведомлении о событии уровня сервера

В следующем примере у представления каталога sys.server_event_notifications запрашиваются метаданные об уведомлении о событии log_ddl1, созданном в области сервера.

SELECT * FROM sys.server_event_notifications  
WHERE name = 'log_ddl1';  

D. Получение сведений об уведомлении о событии уровня базы данных

В следующем примере у представления каталога sys.event_notifications запрашиваются метаданные об уведомлении о событии Notify_ALTER_T1, созданном на уровне базы данных.

SELECT * FROM sys.event_notifications  
WHERE name = 'Notify_ALTER_T1';  

См. также

Уведомления о событиях
DROP EVENT NOTIFICATION (Transact-SQL)
EVENTDATA (Transact-SQL)
sys.event_notifications (Transact-SQL)
sys.server_event_notifications (Transact-SQL)
sys.events (Transact-SQL)
sys.server_events (Transact-SQL)