CLI tools

CrateDB ships with command-line interface (CLI) tools (also referred to as executables) in the bin directory.

If your working directory is CRATE_HOME, you can run an executable like this:

sh$ bin/crate

Otherwise, you can run:

sh$ <PATH_TO_CRATE_HOME>/bin/crate

Here, replace <PATH_TO_CRATE_HOME> with a path to CRATE_HOME.

Alternatively, if the CrateDB bin directory is on your PATH, you can run an executable directly:

sh$ crate

Table of contents

• crate

  • Synopsis

  • Options

  • Signal handling

  • Example

• crate-node

  • Synopsis

  • Commands

  • Options

crate

The crate executable runs the CrateDB daemon.

See also

This section is a low-level command reference. For help installing CrateDB for the first time, check out the CrateDB installation tutorial. Alternatively, consult the deployment guide for help running CrateDB in production.

Synopsis

sh$ bin/crate [-dhvCDX] [-p <PID_FILE>]

Options

Signal handling

The CrateDB process can handle the following signals.

Tip

The TERM signal stops CrateDB immediately. As a result, pending requests may fail. To ensure that CrateDB finishes handling pending requests before the node is stopped, you can, instead, perform a graceful stop with the DECOMMISSION statement.

Example

The simplest way to start a CrateDB instance is to invoke crate without parameters:

sh$ bin/crate

This command starts the process in the foreground.

You can also start CrateDB in the background with the -d option. When doing this, it’s helpful to write the process ID (PID) to a PID file with the -p option. So, in combination:

sh$ bin/crate -d -p crate.pid

To stop the process, send a TERM signal using the PID file, like so:

sh$ kill -TERM `cat crate.pid`

crate-node

The crate-node executable is a tool that can help you:

• Repurpose a node

• Perform an unsafe cluster bootstrap

• Detach a node from its cluster

See also

This section is a low-level command reference. For help using crate-node, consult the troubleshooting guide.

Synopsis

sh$ bin/crate-node repurpose|unsafe-bootstrap|detach-cluster
[--ordinal <INT>] [-E <KV_PAIR>]
[-h, --help] ([-s, --silent] | [-v, --verbose])

Commands

Options