.alter-merge database policy streamingingestion command
Applies to: ✅ Azure Data Explorer
Changes the database streaming ingestion policy. Use the streaming policy to manage streaming ingestion for databases and tables.
Streaming ingestion is best suited for low latency scenarios where the ingestion time is under 10 seconds for varying data volume. It can optimize processing for multiple tables across one or more databases, especially when the tables receive only a few records per second but the ingestion volume is thousands of records per second.
However, when the amount of data grows beyond 4 Gb per hour per table, it's recommended to switch to classic bulk ingestion instead of streaming ingestion.
To learn how to implement streaming ingestion, see streaming ingestion. Streaming ingestion must be enabled on the cluster level before it can be used at the database level.
Permissions
You must have at least Database Admin permissions to run this command.
Syntax
.alter-merge database DatabaseName policy streamingingestion ArrayOfPolicyObjects
Learn more about syntax conventions.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| DatabaseName | string |
✔️ | The name of the database for which to alter the streaming ingestion policy. |
| ArrayOfPolicyObjects | string |
✔️ | A serialized array of one or more JSON policy objects. For more information, see streaming ingestion policy. |
Returns
Returns a JSON representation of the policy.
Example
The following command returns enables streaming ingestion and determines the suggestion allocated rate for the database:
.alter-merge database MyDatabase policy streamingingestion
'{"IsEnabled": true, "HintAllocatedRate": 1.5}'
The following command disables the streaming ingestion policy:
.alter-merge database MyDatabase policy streamingingestion
'{"IsEnabled": false}'