.alter table policy extent_tags_retention command

Switch services using the Version drop-down list. Learn more about navigation.
Applies to: ✅ Azure Data Explorer

Alters the table's extent tags retention policy. For more information, see extent tags retention policy.

Permissions

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

Syntax

.alter table TableName policy extent_tags_retention SerializedPolicyObject

Learn more about syntax conventions.

Learn more about syntax conventions.

Parameters

Name Type Required Description
TableName string ✔️ The name of the table to alter.
SerializedPolicyObject string ✔️ A serialized policy object. See extent tags retention policy.

Example

The following command sets an extent tags retention policy for table T1. The policy causes any drop-by tags that are older than three days and any ingest-by tags that are older than two hours to be automatically dropped.

.alter table T1 policy extent_tags_retention ```[
	{
		"TagPrefix": "drop-by:",
		"RetentionPeriod": "3.00:00:00"
	},
	{
		"TagPrefix": "ingest-by:",
		"RetentionPeriod": "02:00:00"
	}
]```
  • See .show extents commands to see the tags associated with an extent.
  • See the extent-tags() function to see the tags associated with records.