tctl version-next namespace command reference
The tctl namespace commands enable Namespace
operations.
Alias: n
delete
The tctl namespace delete command deletes a Namespace.
tctl namespace delete
The following modifiers are supported and control the behavior of the command. Always include required modifiers when executing this command.
describe
The tctl namespace describe command describes a Namespace.
tctl namespace describe
Alias: d
The following modifiers are supported and control the behavior of the command. Always include required modifiers when executing this command.
--namespace-id
Specify the ID of a Namespace to describe.
This modifier is required unless the global --namespace modifier is specified (tctl --namespace <name> describe).
Example
tctl namespace describe --namespace-id <id>
Example results for a Global Namespace
$ tctl --ns canary-namespace n desc
Name: canary-namespace
Description: testing namespace
OwnerEmail: dev@yourtech.io
NamespaceData:
Status: REGISTERED
RetentionInDays: 7
EmitMetrics: true
ActiveClusterName: dc1
Clusters: dc1, dc2
list
Alias: l
The tctl namespace list command lists all Namespaces.
tctl namespace list
The command has no modifiers.
register
The tctl namespace register command registers a Namespace.
tctl namespace register
By default, Temporal uses a "default" Namespace. Create and register a new Namespace with the following command:
tctl --namespace your-namespace namespace register
# OR using short alias
tctl --ns your-namespace n re
The following modifiers are supported and control the behavior of the command. Always include required modifiers when executing this command.
- --active-cluster
- --clusters
- --description
- --global-namespace
- --history-archival-state
- --history-uri
- --namespace-data
- --owner-email
- --retention
- --visibility-archival-state
- --visibility-uri
update
The tctl namespace update command updates a Namespace.
tctl namespace update
The following modifiers are supported and control the behavior of the command. Always include required modifiers when executing this command.