Cockroach Commands

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.

Commands

Command	Usage
cockroach start	Start a node as part of a multi-node cluster.
cockroach init	Initialize a multi-node cluster.
cockroach start-single-node	Start a single-node cluster.
cockroach cert	Create CA, node, and client certificates.
cockroach quit	Temporarily stop a node or permanently remove a node.
cockroach sql	Use the built-in SQL client.
cockroach sqlfmt	Reformat SQL queries for enhanced clarity.
cockroach node	List node IDs, show their status, decommission nodes for removal, or recommission nodes.
cockroach auth-session	Create and manage web sessions and authentication tokens to the HTTP interface from the command line.
cockroach dump	Deprecated. Use one of the following instead: To back up your data, take a full backup. To export your data in plaintext format, use EXPORT. To view table schema in plaintext, use SHOW CREATE TABLE.
cockroach demo	Start a temporary, in-memory CockroachDB cluster, and open an interactive SQL shell to it.
cockroach gen	Generate manpages, a bash completion file, example SQL data, or an HAProxy configuration file for a running cluster.
cockroach version	Output CockroachDB version details.
cockroach debug ballast	Create a large, unused file in a node's storage directory that you can delete if the node runs out of disk space.
cockroach debug encryption-active-key	View the encryption algorithm and store key.
cockroach debug zip	Generate a .zip file that can help Cockroach Labs troubleshoot issues with your cluster.
cockroach debug merge-logs	Merge multiple log files from different machines into a single stream.
cockroach workload	Run a built-in load generator against a cluster.
cockroach nodelocal upload	Upload a file to the externalIODir on a node's local file system.
cockroach userfile upload	New in v20.2: The cockroach userfile upload command uploads a file to user-scoped file storage.
cockroach userfile list	New in v20.2: List the files stored in the user-scoped file storage.
cockroach userfile delete	New in v20.2: Deletes the files stored in the user-scoped file storage.

Environment variables

For many common cockroach flags, such as --port and --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 env.
• 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:

1. If a flag is set for a command, CockroachDB uses it.
2. If a flag is not set for a command, CockroachDB uses the corresponding environment variable.
3. If neither the flag nor environment variable is set, CockroachDB uses the default for the flag.
4. If there's no flag default, CockroachDB gives an error.

For more details, see Client Connection Parameters.