sys.sp_create_event_stream_group (Transact-SQL)

S'applique à : SQL Server 2025 (17.x) Azure SQL DatabaseAzure SQL Managed InstanceBase de données SQL dans Microsoft Fabric

Crée un flux de groupe d’événements pour la fonctionnalité de changement d’événements en continu (CES) introduite dans SQL Server 2025 (17.x).

Remarque

Le streaming des événements de changement est actuellement en aperçu, et présente des différences de supportabilité selon les produits. Pendant la préversion, cette fonctionnalité est susceptible de changer.

Conventions de la syntaxe Transact-SQL

Syntaxe

sys.sp_create_event_stream_group
    [ @stream_group_name = ] N'stream_group_name'
    , [ @destination_type = ] N'destination_type'
    , [ @destination_location = ] N'destination_location'
    , [ @destination_credential = ] N'destination_credential'
    [ , [ @max_message_size_kb = ] max_message_size_kb ]
    [ , [ @partition_key_scheme = ] N'partition_key_scheme' ]
    [ , [ @partition_key_column_name = ] N'partition_key_column_name' ]
    [ , [ @encoding = ] N'encoding' ]
[ ; ]

Les arguments

[ @stream_group_name = ] N’stream_group_name'

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

[ @destination_type = ] N’destination_type'

Spécifie le type de destination de streaming. @destination_type est sysname, sans valeur par défaut et ne peut pas être NULL.

Important

Le protocole AMQP est obsolète. Pour les nouveaux groupes de flux, utilisez AzureEventHubs (Azure SQL Database) ou AzureEventHubsApacheKafka (Azure SQL Managed Instance, SQL Server 2025). Pour plus de détails, voir dépréciation du protocole AMQP.

@destination_type peut être l’une des valeurs suivantes :

Valeur Compatible avec Remarques
AzureEventHubs Azure SQL Database,
Base de données SQL dans Microsoft Fabric		 La seule valeur acceptée sur ces plateformes. Utilise le protocole Kafka.
AzureEventHubsApacheKafka Azure SQL Managed Instance,
SQL Server 2025		 Recommandé pour les nouveaux groupes de diffusion sur ces plateformes. Utilise le protocole Kafka.
AzureEventHubsAmqp Azure SQL Managed Instance,
SQL Server 2025		 Deprecated. Utilise le protocole AMQP. À éviter pour les nouveaux groupes de stream.

[ @destination_location = ] N’destination_location'

Décrit l’espace de noms et le nom de l’instance Azure Event Hubs. @destination_location est nvarchar(4000), sans valeur par défaut et ne peut pas être NULL.

Pour le protocole Apache Kafka, spécifiez le port.

[ @destination_credential = ] N’destination_credential'

Spécifie le nom des informations d’identification délimitées à la base de données à utiliser. @destination_credential est sysname, sans valeur par défaut et ne peut pas être NULL.

[ @max_message_size_kb = ] max_message_size_kb

Si elle est spécifiée, définit la taille maximale du message CES en kilo-octets. @max_message_size_kb est int, et ne peut pas être NULL. Le message est fractionné s’il dépasse la taille maximale spécifiée. Ce paramètre est facultatif.

@max_message_size_kb présente les caractéristiques suivantes :

Valeur Descriptif
128 (minimum) Correspond à 128 Ko
256 (valeur par défaut) Correspond à 256 Ko
1024 (maximum) Correspond à 1 Mo

Le paramètre @max_message_size_kb doit s’aligner sur les limites de la destination. Par exemple, la taille maximale des messages pour Azure Event Hubs est de 1 Mo pour les niveaux Standard et Premium. Pour plus d’informations, consultez les quotas Azure Event Hubs.

[ @partition_key_scheme = ] N’partition_key_scheme'

Définit le type de partitionnement. @partition_key_scheme est sysname et ne peut pas être NULL.

@partition_key_scheme peut être l’une des valeurs suivantes :

Valeur Descriptif
None (valeur par défaut) Le partitionnement n’est pas spécifié. Les événements sont donc affectés aux partitions par le hub d’événements à l’aide d’une stratégie de tourniquet.
StreamGroup Le partitionnement est effectué par le groupe de flux afin que toutes les tables du groupe de flux soient diffusées vers la même partition.
Table Le partitionnement est effectué par table afin que les événements provenant de la même table dans le groupe de flux soient garantis d’être envoyés à la même partition. La clé de partitionnement est l’identifiant interne de la table.
Column Le partitionnement s’effectue selon la valeur de la colonne spécifiée par le partition_key_column_name paramètre. Les événements sont attribués aux partitions en fonction de la valeur de cette colonne dans la ligne pour laquelle l’événement est publié.

[ @partition_key_column_name = ] N’partition_key_column_name'

Définit la colonne à utiliser pour le partitionnement lorsque @partition_key_scheme est défini Columnsur . @partition_key_column_name est sysname et ne peut pas être NULL.

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.

[ @encoding = ] N’encoding'

Spécifie l’encodage du message. @encoding est sysname et ne peut pas être NULL.

@encoding peut être l’une des valeurs suivantes :

  • JSON (valeur par défaut)
  • Binary

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.

Exemples

Un. Create event stream group sur Azure SQL Database

EXECUTE sys.sp_create_event_stream_group
    @stream_group_name = N'myStreamGroup',
    @destination_type = N'AzureEventHubs',
    @destination_location = N'myEventHubsNamespace.servicebus.windows.net:9093/myEventHubsInstance',
    @destination_credential = MyDatabaseScopedCredentialForCes;

B. Créer un groupe de flux d’événements sur Azure SQL Managed Instance ou SQL Server 2025

EXECUTE sys.sp_create_event_stream_group
    @stream_group_name = N'myStreamGroup',
    @destination_type = N'AzureEventHubsApacheKafka',
    @destination_location = N'myEventHubsNamespace.servicebus.windows.net:9093/myEventHubsInstance',
    @destination_credential = MyDatabaseScopedCredentialForCes;

Contenu connexe

  • Last updated on