Getting started

Installation

Python package

Crash is available as a package from PyPI.

To install the most recent version, run:

sh$ pipx install crash

Now, run it:

sh$ crash

Run

You can start Crash like so:

sh$ crash

When crash is run without any additional arguments, it will attempt to connect to localhost:4200. To connect to another host, use the --hosts flag. For example:

sh$ crash --host "198.51.100.1"

If you are experiencing a connection error, try the --verbose flag:

sh$ crash --verbose

When run with --verbose, Crash will print useful information about what it is doing to STDOUT. This includes connection attempts and full stack traces (in the case of an error).

See also

For more help, see Running Crash.

Query

When you run Crash, it will greet you with an SQL prompt:

This is an interactive shell. You can type any CrateDB SQL query at the cr> prompt.

Queries are autocompleted as you type:

Once you have entered your query, terminate it using ;, and hit Enter to execute it.

You should see something like this:

See also

For more help, see Commands or Response formats.