.alter table policy streamingingestion command

Use this command to change the table streaming policy ingestion. Use the streaming policy to manage streaming ingestion for databases and tables.

Use in low latency scenarios, where ingestion time is less than 10 seconds for varying data volume. You can optimize processing for many tables in one or more databases, when tables receive a few records per second, whereas the ingestion volume is thousands of records per second.

Use the classic bulk ingestion instead of streaming ingestion when the amount of data grows to more than 4 Gb per hour per table.

To learn how to implement streaming ingestion, see streaming policy.

Permissions

You must have at least Table Admin permissions to run this command.

Syntax

.alter table TableName policy streamingingestion PolicyObject

Learn more about syntax conventions.

Parameters

Name Type Required Description
TableName string ✔️ The name of the table.
PolicyObject string ✔️ A serialized policy object. For more information, see streaming ingestion.

Returns

Returns a JSON representation of the policy.

Example

The following command turns on streaming ingestion and determines the suggested allocation rate for the table.

.alter table Table1 policy streamingingestion '{"IsEnabled": true, "HintAllocatedRate": 2.1}'