OS Manuals

/usr/bin/temporal-cassandra-tool

temporal-cassandra-tool

From temporal-cassandra-tool 1.31.0-r2 (os), captured 2026-11-05 by running temporal-cassandra-tool --help (exit 0). permalink

Also provided by 8 other package versions
NAME:
   temporal-cassandra-tool - Command line tool for temporal cassandra operations

USAGE:
   temporal-cassandra-tool [global options] command [command options] [arguments...]

VERSION:
   1.31.0

COMMANDS:
   setup-schema, setup                       setup initial version of cassandra schema
   update-schema, update                     update cassandra schema to a specific version
   create-keyspace, create, create-Keyspace  creates a keyspace with simple strategy or network topology if datacenter name is provided
   drop-keyspace, drop                       drops a keyspace with simple strategy or network topology if datacenter name is provided
   validate-health, vh                       validates health of cassandra by attempting to establish CQL session to system keyspace
   help, h                                   Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --endpoint value, --ep value                hostname or ip address of cassandra host to connect to (default: "127.0.0.1") [$CASSANDRA_HOST]
   --port value, -p value                      Port of cassandra host to connect to (default: 9042) [$CASSANDRA_PORT]
   --user value, -u value                      User name used for authentication for connecting to cassandra host [$CASSANDRA_USER]
   --password value, --pw value                Password used for authentication for connecting to cassandra host [$CASSANDRA_PASSWORD]
   --allowed-authenticators value, --aa value  List of authenticators allowed to be used by the gocql client while connecting to the server. [$CASSANDRA_ALLOWED_AUTHENTICATORS]
   --timeout value, -t value                   request Timeout in seconds used for cql client (default: 30) [$CASSANDRA_TIMEOUT]
   --keyspace value, -k value                  name of the cassandra Keyspace (default: "temporal") [$CASSANDRA_KEYSPACE]
   --datacenter value, --dc value              enable NetworkTopologyStrategy by providing datacenter name [$CASSANDRA_DATACENTER]
   --address-translator value                  name of address translator for cassandra hosts [$CASSANDRA_ADDRESS_TRANSLATOR]
   --address-translator-options value          colon-separated list of key=value pairs as options for address translator [$CASSANDRA_ADDRESS_TRANSLATOR_OPTIONS_CLI]
   --quiet, -q                                 Don't set exit status to 1 on error
   --disable-initial-host-lookup               instructs gocql driver to only connect to the supplied hosts vs. attempting to lookup additional hosts via the system.peers table [$CASSANDRA_DISABLE_INITIAL_HOST_LOOKUP]
   --tls                                       enable TLS [$CASSANDRA_ENABLE_TLS]
   --tls-cert-file value                       TLS cert file [$CASSANDRA_TLS_CERT]
   --tls-key-file value                        TLS key file [$CASSANDRA_TLS_KEY]
   --tls-ca-file value                         TLS CA file [$CASSANDRA_TLS_CA]
   --tls-server-name value                     override for target server name [$CASSANDRA_TLS_SERVER_NAME]
   --tls-disable-host-verification             disable tls host name verification (tls must be enabled) [$CASSANDRA_TLS_DISABLE_HOST_VERIFICATION]
   --help, -h                                  show help
   --version, -v                               print the version
Options (20)
OptionDescriptionSource
--endpoint, --ep valuehostname or ip address of cassandra host to connect to (default: "127.0.0.1") [$CASSANDRA_HOST]help
--port, -p valuePort of cassandra host to connect to (default: 9042) [$CASSANDRA_PORT]help
--user, -u valueUser name used for authentication for connecting to cassandra host [$CASSANDRA_USER]help
--password, --pw valuePassword used for authentication for connecting to cassandra host [$CASSANDRA_PASSWORD]help
--allowed-authenticators, --aa valueList of authenticators allowed to be used by the gocql client while connecting to the server.help
--timeout, -t valuerequest Timeout in seconds used for cql client (default: 30) [$CASSANDRA_TIMEOUT]help
--keyspace, -k valuename of the cassandra Keyspace (default: "temporal") [$CASSANDRA_KEYSPACE]help
--datacenter, --dc valueenable NetworkTopologyStrategy by providing datacenter name [$CASSANDRA_DATACENTER]help
--address-translator valuename of address translator for cassandra hosts [$CASSANDRA_ADDRESS_TRANSLATOR]help
--address-translator-options valuecolon-separated list of key=value pairs as options for address translator [$CASSANDRA_ADDRESS_TRANSLATOR_OPTIONS_CLI]help
--quiet, -qDon't set exit status to 1 on errorhelp
--disable-initial-host-lookupinstructs gocql driver to only connect to the supplied hosts vs.help
--tlsenable TLS [$CASSANDRA_ENABLE_TLS]help
--tls-cert-file valueTLS cert file [$CASSANDRA_TLS_CERT]help
--tls-key-file valueTLS key file [$CASSANDRA_TLS_KEY]help
--tls-ca-file valueTLS CA file [$CASSANDRA_TLS_CA]help
--tls-server-name valueoverride for target server name [$CASSANDRA_TLS_SERVER_NAME]help
--tls-disable-host-verificationdisable tls host name verification (tls must be enabled) [$CASSANDRA_TLS_DISABLE_HOST_VERIFICATION]help
--help, -hshow helphelp
--version, -vprint the versionhelp

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.