Compartir a través de


sys.sp_add_object_to_event_stream_group (Transact-SQL)

Se aplica a: SQL Server 2025 (17.x) Azure SQL Database

Añade un objeto (es decir, una tabla) al grupo de flujo para la función de transmisión de eventos de cambio (CES) introducida en SQL Server 2025 (17.x) y Azure SQL Database.

Nota:

El streaming de eventos de cambio se encuentra actualmente en versión preliminar para:

Durante la versión preliminar, esta característica está sujeta a cambios. Para obtener compatibilidad actual, consulte Limitaciones.

Convenciones de sintaxis de Transact-SQL

Sintaxis

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 el nombre del grupo de secuencias de eventos al que desea agregar la tabla. @stream_group_name es sysname, sin valor predeterminado y no puede ser NULL.

[ @object_name = ] N'schema_name_dot_object_name'

Especifica el nombre de la tabla que desea transmitir como parte del grupo de flujos especificado. @object_name es nvarchar(512), sin ningún valor predeterminado y no puede ser NULL.

Nota:

Actualmente solo se admiten tablas. La configuración de CES en vistas produce un error.

Use un nombre de dos partes para la columna que incluya tanto el nombre de esquema como el nombre de columna. Por ejemplo, un valor válido es dbo.Addresses.

[ @include_all_columns = ] include_all_columns

Define qué columnas se van a incluir dentro de la carga del mensaje que transmite los cambios realizados a la tabla especificada.

@include_all_columns es bit y debe ser uno de los siguientes valores:

Importancia Descripción
1 (valor predeterminado) Incluye todas las columnas dentro de la carga del mensaje que transmite los cambios realizados a la tabla especificada.
0 Solo incluye columnas que han cambiado dentro de la carga del mensaje que transmite los cambios realizados a la tabla especificada.

[ @include_old_values = ] include_old_values

Si se especifica, include_old_values determina si los valores antiguos se incluyen dentro de la carga del mensaje que transmite los cambios realizados a la tabla especificada.

@include_old_values es bit y debe ser uno de los siguientes valores:

Importancia Descripción
1 (valor predeterminado) Incluye valores antiguos dentro de la carga del mensaje que transmite los cambios realizados a la tabla especificada.
0 Omite los valores antiguos dentro de la carga del mensaje que transmite los cambios realizados a la tabla especificada.

Los valores antiguos son los valores de la columna antes de realizar el cambio. Por ejemplo, si se actualiza una fila, los valores antiguos son los valores de las columnas antes de la actualización.

[ @include_old_lob_values = ] include_old_lob_values

Determina si los valores de objetos grandes modificados antiguos (LOB) se incluyen dentro de la carga del mensaje que transmite los cambios realizados a la tabla especificada.

@include_old_lob_values es bit y debe ser uno de los siguientes valores:

Importancia Descripción
1 Incluye todas las columnas dentro de la carga del mensaje que transmite los cambios realizados a la tabla especificada.
0 (valor predeterminado) Solo incluye columnas que han cambiado dentro de la carga del mensaje que transmite los cambios realizados a la tabla especificada.

Los valores antiguos son los valores de la columna antes de realizar el cambio. Por ejemplo, si se actualiza una fila, los valores antiguos son los valores de las columnas antes de la actualización.

Valores de código de retorno

0 (correcto) o 1 (erróneo).

Permisos

Un usuario con CONTROL permisos de base de datos, db_owner pertenencia a roles de base de datos o pertenencia a roles de servidor sysadmin puede ejecutar este procedimiento.