.alter database policy streamingingestion command
Applies to: ✅ Azure Data Explorer
Changes the database streaming ingestion policy. The streaming policy manages streaming ingestion of data into 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, we recommend switching to classic bulk ingestion instead of streaming ingestion.
To learn how to implement streaming ingestion, see streaming ingestion. Streaming ingestion must be enabled at 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
database
DatabaseName policy
streamingingestion
PolicyObject
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. |
PolicyObject | string |
✔️ | A policy object that defines the streaming ingestion policy. For more information, see the streaming policy. |
Returns
Returns a JSON representation of the policy.
Example
The following command enables streaming ingestion and determines the suggestion allocated rate for the database:
.alter database MyDatabase policy streamingingestion
'{"IsEnabled": true, "HintAllocatedRate": 2.1}'