Partager via


sys.sp_add_object_to_event_stream_group (Transact-SQL)

S’applique à : SQL Server 2025 (17.x) Azure SQL Database

Ajoute un objet (c’est-à-dire une table) au groupe de flux pour la fonctionnalité de changement d’événements en continu (CES) introduite dans SQL Server 2025 (17.x) et Azure SQL Database.

Remarque

La diffusion en continu d’événements change actuellement en préversion pour :

Pendant la préversion, cette fonctionnalité est susceptible de changer. Pour connaître la prise en charge actuelle, consultez Limitations.

Conventions de la syntaxe Transact-SQL

Syntaxe

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

Les arguments

[ @stream_group_name = ] N’stream_group_name'

Spécifie le nom du groupe de flux d’événements auquel vous souhaitez ajouter la table. @stream_group_name est sysname, sans valeur par défaut et ne peut pas être NULL.

[ @object_name = ] N’schema_name_dot_object_name'

Spécifie le nom de la table que vous souhaitez diffuser dans le cadre du groupe de flux spécifié. @object_name est nvarchar(512), sans valeur par défaut et ne peut pas être NULL.

Remarque

Seules les tables sont actuellement prises en charge. La configuration de CES sur les vues entraîne une erreur.

Utilisez un nom en deux parties pour la colonne qui inclut le nom du schéma et le nom de colonne. Par exemple, une valeur valide est dbo.Addresses.

[ @include_all_columns = ] include_all_columns

Définit les colonnes à inclure dans la charge utile du message qui diffuse les modifications apportées à la table spécifiée.

@include_all_columns est bit et doit être l’une des valeurs suivantes :

Valeur Descriptif
1 (valeur par défaut) Inclut toutes les colonnes dans la charge utile du message qui diffuse les modifications apportées à la table spécifiée.
0 Inclut uniquement les colonnes qui ont changé dans la charge utile du message qui diffuse les modifications apportées à la table spécifiée.

[ @include_old_values = ] include_old_values

Si elle est spécifiée, include_old_values détermine si les anciennes valeurs sont incluses dans la charge utile du message qui diffuse les modifications apportées à la table spécifiée.

@include_old_values est bit et doit être l’une des valeurs suivantes :

Valeur Descriptif
1 (valeur par défaut) Inclut les anciennes valeurs dans la charge utile du message qui diffuse les modifications apportées à la table spécifiée.
0 Ignore les anciennes valeurs dans la charge utile du message qui diffuse les modifications apportées à la table spécifiée.

Les anciennes valeurs sont les valeurs de la colonne avant la modification. Par exemple, si une ligne est mise à jour, les anciennes valeurs sont les valeurs des colonnes avant la mise à jour.

[ @include_old_lob_values = ] include_old_lob_values

Détermine si les anciennes valeurs d’objets volumineux modifiés sont incluses dans la charge utile du message qui diffuse les modifications apportées à la table spécifiée.

@include_old_lob_values est bit et doit être l’une des valeurs suivantes :

Valeur Descriptif
1 Inclut toutes les colonnes dans la charge utile du message qui diffuse les modifications apportées à la table spécifiée.
0 (valeur par défaut) Inclut uniquement les colonnes qui ont changé dans la charge utile du message qui diffuse les modifications apportées à la table spécifiée.

Les anciennes valeurs sont les valeurs de la colonne avant la modification. Par exemple, si une ligne est mise à jour, les anciennes valeurs sont les valeurs des colonnes avant la mise à jour.

Valeurs des codes de retour

0 (réussite) or 1 (échec).

Autorisations

Un utilisateur disposant CONTROL d’autorisations de base de données, db_owner appartenance au rôle de base de données ou d’appartenance au rôle serveur sysadmin peut exécuter cette procédure.