.alter-merge table policy retention command

Applies to: ✅ Azure Data Explorer

Changes the table's retention policy. The retention policy controls the mechanism that automatically removes data from tables or materialized views. It is used to remove data whose relevance is age-based. The retention policy can be configured for a specific table or materialized view, or for an entire database. The policy then applies to all tables in the database that don't override it.

Permissions

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

Syntax

.alter-merge table TableName policy retention PolicyParameters

Learn more about syntax conventions.

Parameters

Name Type Required Description
TableName string ✔️ The name of the table.
PolicyParameters string ✔️ One or more policy parameters. For more information, see retention policy.

Example

Sets a retention policy with a 10-day soft-delete period, and disables data recoverability:

.alter-merge table Table1 policy retention softdelete = 10d recoverability = disabled