tctl admin cluster remove_search_attributes

The Temporal tctl documentation covers version 1.16 of the Temporal CLI.

The tctl admin cluster remove-search-attributes command removes custom Search Attribute metadata from a Cluster. This operation has no effect on Elasticsearch index schema.

Use the following command to remove a Search Attribute from a Cluster's metadata:

tctl admin cluster remove-search-attributes --name <SearchAttributeKey>

Only custom Search Attributes can be removed from a Cluster's metadata. Default Search Attributes cannot be removed.

Removing a Search Attribute removes it from the Cluster's metadata but does not remove it from the Elasticsearch index. This means that the Search Attribute can be added back later as the same type. After a Search Attribute has been added to the Elasticsearch index, it cannot be changed.

Modifiers

The following modifier changes the behavior of the operation:

--name value

Name of the Search Attribute to remove.