On this page
Warning:CockroachDB v2.1 is no longer supported. For more details, see the Release Support Policy.
This page introduces the
cockroach commands for configuring, starting, and managing a CockroachDB cluster, as well as environment variables that can be used in place of certain flags.
You can run
cockroach help in your shell to get similar guidance.
||Start a node.|
||Initialize a cluster.|
||Create CA, node, and client certificates.|
||Temporarily stop a node or permanently remove a node.|
||Use the built-in SQL client.|
||New in v2.1: Reformat SQL queries for enhanced clarity.|
||Get, set, list, and remove users.|
||Deprecated To configure the number and location of replicas for specific sets of data, use
||List node IDs, show their status, decommission nodes for removal, or recommission nodes.|
||Back up a table by outputting the SQL statements required to recreate the table and all its rows.|
||New in v2.1: Start a temporary, in-memory, single-node CockroachDB cluster, and open an interactive SQL shell to it.|
||Generate manpages, a bash completion file, example SQL data, or an HAProxy configuration file for a running cluster.|
||Output CockroachDB version details.|
||Run a built-in load generator against a cluster.|
For many common
cockroach flags, such as
--user, you can set environment variables once instead of manually passing the flags each time you execute commands.
- To find out which flags support environment variables, see the documentation for each command.
- To output the current configuration of CockroachDB and other environment variables, run
- When a node uses environment variables on startup, the variable names are printed to the node's logs; however, the variable values are not.
CockroachDB prioritizes command flags, environment variables, and defaults as follows:
- If a flag is set for a command, CockroachDB uses it.
- If a flag is not set for a command, CockroachDB uses the corresponding environment variable.
- If neither the flag nor environment variable is set, CockroachDB uses the default for the flag.
- If there's no flag default, CockroachDB gives an error.
For more details, see Client Connection Parameters.