tctl namespace update
The tctl namespace update
command updates a Namespace.
tctl namespace update
The following modifiers control the behavior of the command.
--active_cluster
Specify the name of the active Temporal Cluster when updating a Namespace.
Alias: --ac
Example
tctl namespace update --active_cluster <name>
--add_bad_binary
Add a binary checksum to use when resetting a Workflow Execution. Temporal will not dispatch any Commands to the given binary.
See also --remove_bad_binary
.
Example
tctl namespace update --add_bad_binary <value>
--clusters
Specify a list of Temporal Clusters when updating a Namespace.
The list contains the names of Clusters (separated by spaces) to which the Namespace can fail over.
This modifier is valid only when the --global_namespace
modifier is set to true.
Alias --cl
Example
tctl namespace update --clusters <names>
--description
Specify a description when updating a Namespace.
Alias --desc
Example
tctl namespace update --description <value>
--history_archival_state
Set the state of Archival.
Valid values are disabled
and enabled
.
Alias --has
Example
tctl namespace update --history_archival_state <value>
--history_uri
Specify the URI for URI for Archival. The URI cannot be changed after Archival is first enabled.
Alias --huri
Example
tctl namespace update --history_uri <uri>
--namespace_data
Specify data for a Namespace in the form of key-value pairs (such as k1:v1,k2:v2,k3:v3
).
Alias --dmd
Example
tctl namespace update --namespace_data <data>
--owner_email
Specify the email address of the Namespace owner.
Alias --oe
Example
tctl namespace update --owner_email <value>
--reason
Specify a reason for updating a Namespace.
Example
tctl namespace update --reason <value>
--remove_bad_binary
Remove a binary checksum.
See also --add_bad_binary
.
Example
tctl namespace update --remove_bad_binary <value>
--retention
Specify the number of days to retain Workflow Executions.
Alias --rd
Example
tctl namespace update --retention <value>
--visibility_archival_state
Set the visibility state for Archival.
Valid values are disabled
and enabled
.
Alias --vas
Example
tctl namespace update --visibility_archival_state <value>
--visibility_uri
Specify the visibility URI for Archival. The URI cannot be changed after Archival is first enabled.
Alias --vuri
Example
tctl namespace update --visibility_uri <uri>