sys.sp_add_object_to_event_stream_group (Transact-SQL)

Применимо к:База данных SQL Azure 2025 (17.x)

Добавляет объект (то есть таблицу) в группу потоков для функции потокового потока событий изменений (CES ), введённой в SQL Server 2025 (17.x) и Azure SQL Database.

Замечание

Потоковая передача событий изменений в настоящее время доступна в предварительной версии для:

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

Синтаксис

sys.sp_add_object_to_event_stream_group
    [ @stream_group_name = ] N'stream_group_name'
    , [ @object_name = ] N'schema_name_dot_object_name'
    [ , [ @include_all_columns = ] include_all_columns ]
    [ , [ @include_old_values = ] include_old_values ]
    [ , [ @include_old_lob_values = ] include_old_lob_values ]
[ ; ]

Аргументы

[ @stream_group_name = ] N'stream_group_name'

Указывает имя группы потоков событий, к которой нужно добавить таблицу. @stream_group_name является sysname, без значения по умолчанию и не может быть NULL.

[ @object_name = ] N'schema_name_dot_object_name'

Указывает имя таблицы, которую нужно выполнить в составе указанной группы потоков. @object_name является nvarchar(512), без значения по умолчанию и не может быть NULL.

Замечание

В настоящее время поддерживаются только таблицы. Настройка CES для представлений приводит к ошибке.

Используйте двухпартийное имя столбца, включающее имя схемы и имя столбца. Например, допустимое значение dbo.Addresses.

[ @include_all_columns = ] include_all_columns

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

@include_all_columnsбит и должен быть одним из следующих значений:

Ценность Описание
1 (по умолчанию) Включает все столбцы в полезные данные сообщения, которое передает изменения, внесенные в указанную таблицу.
0 Включает только столбцы, которые изменились в полезных данных сообщения, который передает изменения, внесенные в указанную таблицу.

[ @include_old_values = ] include_old_values

Если задано, include_old_values определяет, включены ли старые значения в полезные данные сообщения, которые передают изменения, внесенные в указанную таблицу.

@include_old_valuesбит и должен быть одним из следующих значений:

Ценность Описание
1 (по умолчанию) Содержит старые значения в полезных данных сообщения, который передает изменения, внесенные в указанную таблицу.
0 Пропускает старые значения в полезных данных сообщения, которое передает изменения, внесенные в указанную таблицу.

Старые значения — это значения столбца до внесения изменений. Например, если строка обновляется, старые значения являются значениями столбцов перед обновлением.

[ @include_old_lob_values = ] include_old_lob_values

Определяет, включены ли старые измененные значения больших объектов (LOB) в полезные данные сообщения, который передает изменения, внесенные в указанную таблицу.

@include_old_lob_valuesбит и должен быть одним из следующих значений:

Ценность Описание
1 Включает все столбцы в полезные данные сообщения, которое передает изменения, внесенные в указанную таблицу.
0 (по умолчанию) Включает только столбцы, которые изменились в полезных данных сообщения, который передает изменения, внесенные в указанную таблицу.

Старые значения — это значения столбца до внесения изменений. Например, если строка обновляется, старые значения являются значениями столбцов перед обновлением.

Значения кода возврата

0 (успешно) или 1 (сбой).

Разрешения

Пользователь с разрешениями базы данных, CONTROL в роли базы данных или членством в роли сервера sysadmin может выполнять эту процедуру.