sys.sp_add_object_to_event_stream_group (Transact-SQL)

Aplica-se a: SQL Server 2025 (17.x) Banco de Dados SQL do Azure

Adiciona um objeto (ou seja, uma tabela) ao grupo de fluxo para o recurso de mudança de fluxo de eventos (CES) introduzido no SQL Server 2025 (17.x) e no Azure SQL Database.

Convenções de sintaxe de Transact-SQL

Sintaxe

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 ]
[ ; ]

Argumentos

[ @stream_group_name = ] N'stream_group_name'

Especifica o nome do grupo de fluxo de eventos ao qual você deseja adicionar a tabela. @stream_group_name é sysname, sem padrão e não pode ser NULL.

[ @object_name = ] N'schema_name_dot_object_name'

Especifica o nome da tabela que você deseja transmitir como parte do grupo de fluxo especificado. @object_name é nvarchar(512),sem padrão e não pode ser NULL.

Use um nome de duas partes para a coluna que inclui o nome do esquema e o nome da coluna. Por exemplo, um valor válido é dbo.Addresses.

[ @include_all_columns = ] include_all_columns

Define quais colunas incluir no conteúdo da mensagem que transmite as alterações feitas à tabela especificada.

@include_all_columns é bit e deve ser um dos seguintes valores:

[ @include_old_values = ] include_old_values

Se especificado, include_old_values determina se os valores antigos são incluídos no conteúdo da mensagem que transmite as alterações feitas à tabela especificada.

@include_old_values é bit e deve ser um dos seguintes valores:

Valores antigos são os valores da coluna antes da alteração ser feita. Por exemplo, se uma linha for atualizada, os valores antigos serão os valores das colunas antes da atualização.

[ @include_old_lob_values = ] include_old_lob_values

Determina se valores lob (objetos grandes) alterados antigos estão incluídos no conteúdo da mensagem que transmite as alterações feitas à tabela especificada.

@include_old_lob_values é bit e deve ser um dos seguintes valores:

Valores antigos são os valores da coluna antes da alteração ser feita. Por exemplo, se uma linha for atualizada, os valores antigos serão os valores das colunas antes da atualização.

Valores do código de retorno

0 (sucesso) ou 1 (falha).

Permissões

Um usuário com CONTROL permissões de banco de dados, db_owner associação de função de banco de dados ou associação de função de servidor sysadmin pode executar esse procedimento.

Conteúdo relacionado

• O que é o streaming de eventos de alteração (versão prévia)?
• Configurar o streaming de eventos de alteração (versão prévia)