OS Manuals

/usr/bin/temporal-sql-tool

temporal-sql-tool

From temporal-sql-tool-1.30 1.30.9-r0 (enterprise-packages), captured 2026-11-08 by running temporal-sql-tool --help (exit 0). permalink

NAME:
   temporal-sql-tool - Command line tool for temporal sql operations

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

VERSION:
   1.30.9

COMMANDS:
   setup-schema, setup      setup initial version of sql schema
   update-schema, update    update sql schema to a specific version
   create-database, create  creates a database
   drop-database, drop      drops a database
   help, h                  Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --endpoint value, --ep value            hostname or ip address of sql host to connect to (default: "127.0.0.1") [$SQL_HOST]
   --port value, -p value                  port of sql host to connect to (default: 3306) [$SQL_PORT]
   --user value, -u value                  user name used for authentication when connecting to sql host [$SQL_USER]
   --password value, --pw value            password used for authentication when connecting to sql host [$SQL_PASSWORD]
   --database value, --db value            name of the sql database (default: "temporal") [$SQL_DATABASE]
   --plugin value, --pl value              name of the sql plugin (default: "mysql8") [$SQL_PLUGIN]
   --quiet, -q                             Don't set exit status to 1 on error
   --connect-attributes value, --ca value  sql connect attributes [$SQL_CONNECT_ATTRIBUTES]
   --tls                                   enable TLS over sql connection [$SQL_TLS]
   --tls-cert-file value                   sql tls client cert path (tls must be enabled) [$SQL_TLS_CERT_FILE]
   --tls-key-file value                    sql tls client key path (tls must be enabled) [$SQL_TLS_KEY_FILE]
   --tls-ca-file value                     sql tls client ca file (tls must be enabled) [$SQL_TLS_CA_FILE]
   --tls-server-name value                 override for target server name [$SQL_TLS_SERVER_NAME]
   --tls-disable-host-verification         disable tls host name verification (tls must be enabled) [$SQL_TLS_DISABLE_HOST_VERIFICATION]
   --help, -h                              show help
   --version, -v                           print the version
Options (16)
OptionDescriptionSource
--endpoint, --ep valuehostname or ip address of sql host to connect to (default: "127.0.0.1") [$SQL_HOST]help
--port, -p valueport of sql host to connect to (default: 3306) [$SQL_PORT]help
--user, -u valueuser name used for authentication when connecting to sql host [$SQL_USER]help
--password, --pw valuepassword used for authentication when connecting to sql host [$SQL_PASSWORD]help
--database, --db valuename of the sql database (default: "temporal") [$SQL_DATABASE]help
--plugin, --pl valuename of the sql plugin (default: "mysql8") [$SQL_PLUGIN]help
--quiet, -qDon't set exit status to 1 on errorhelp
--connect-attributes, --ca valuesql connect attributes [$SQL_CONNECT_ATTRIBUTES]help
--tlsenable TLS over sql connection [$SQL_TLS]help
--tls-cert-file valuesql tls client cert path (tls must be enabled) [$SQL_TLS_CERT_FILE]help
--tls-key-file valuesql tls client key path (tls must be enabled) [$SQL_TLS_KEY_FILE]help
--tls-ca-file valuesql tls client ca file (tls must be enabled) [$SQL_TLS_CA_FILE]help
--tls-server-name valueoverride for target server name [$SQL_TLS_SERVER_NAME]help
--tls-disable-host-verificationdisable tls host name verification (tls must be enabled) [$SQL_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.