Skip to main content

The Crate Data Shell

Project description

Crash

Travis CI Version Documentation Python Version Coverage

Crash is an interactive CrateDB command line interface (CLI) SQL shell with autocompletion.

Screenshot

A screenshot of Crash

Prerequisites

Recent versions of Crash require Python (>= 2.7) to run.

Use Crash 0.16.0 if you’re running Python 2.6.

Installation

As a Python Package

Crash is available as a pip package.

To install, run:

$ pip install crash

Now, run it:

$ crash

To update, run:

$ pip install -U crash

Standalone

Crash is also available as a standalone executable that includes all the necessary dependencies, and can be run as long as Python (>= 2.7) is available.

First, download the executable:

$ curl -o crash https://cdn.crate.io/downloads/releases/crash_standalone_latest

Then, make it executable:

$ chmod +x crash

Now, run it:

$ ./crash

If you would like to run crash from any directory and without using leading ./ you will need to move it to somewhere on your $PATH.

Usage

For usage information and options, run:

$ crash --help

Contributing

This project is primarily maintained by Crate.io, but we welcome community contributions!

See the developer docs and the contribution docs for more information.

Help

Looking for more help?

Installation & Usage

If the package was installed using pip the shell can be started by invoking crash in a terminal. We recommend to install it to the Python user install directory to avoid unwanted dependency conflicts.

pip install --user crash

crash by default will try to connect to localhost:4200. To connect to another host use the connect command inside the shell or use the --hosts argument when launching the shell.

crash started with the -v switch (once or more times) will log useful information when it comes to debugging, like what connection attempts are made and full tracebacks of server errors.

For more information about the available command line arguments see Command Line Arguments.

When you connect to a server that is not reachable or whose hostname cannot be resolved you will get an error:

cr> \connect 127.0.0.1:65535
+------------------------+-----------+---------+-----------+-----------...-+
| server_url             | node_name | version | connected | message       |
+------------------------+-----------+---------+-----------+-----------...-+
| http://127.0.0.1:65535 |      NULL | 0.0.0   | FALSE     | Server not... |
+------------------------+-----------+---------+-----------+-----------...-+
CONNECT ERROR
cr> \connect 300.300.300.300:4200
+-----------------------------+-----------+---------+-----------+-------------...-+
| server_url                  | node_name | version | connected | message         |
+-----------------------------+-----------+---------+-----------+-------------...-+
| http://300.300.300.300:4200 |      NULL | 0.0.0   | FALSE     | Server not a... |
+-----------------------------+-----------+---------+-----------+-------------...-+
CONNECT ERROR

Successful connects will give you some information about the servers you connect to:

cr> \connect 127.0.0.1:44209;
+------------------------+-----------+---------+-----------+---------+
| server_url             | node_name | version | connected | message |
+------------------------+-----------+---------+-----------+---------+
| http://127.0.0.1:44209 | crate     | ...     | TRUE      | OK      |
+------------------------+-----------+---------+-----------+---------+
CONNECT OK...

If you connect to more than one server, the command will succeed if at least one server is reachable:

cr> \connect 127.0.0.1:44209 300.300.300.300:4295;
+-----------------------------+-----------+---------+-----------+-----------...-+
| server_url                  | node_name | version | connected | message       |
+-----------------------------+-----------+---------+-----------+-----------...-+
| http://127.0.0.1:44209      | crate     | ...     | TRUE      | OK            |
| http://300.300.300.300:4295 | NULL      | 0.0.0   | FALSE     | Server not... |
+-----------------------------+-----------+---------+-----------+-----------...-+
CONNECT OK...

Once the shell is connected, SQL statements can be executed simply by entering them without any special arguments like this:

cr> SELECT table_name FROM information_schema.tables
... WHERE table_name = 'cluster';
+------------+
| table_name |
+------------+
| cluster    |
+------------+
SELECT 1 row in set (... sec)

When the CrateDB shell is started with the option -v debugging information will be printed:

cr> select x from y;
SQLActionException[TableUnknownException: Table 'doc.y' unknown]
SQLActionException: NOT_FOUND 4041 TableUnknownException: Table 'doc.y' unknown
...

Limitations

Nested Objects and Arrays

While it is possible to select or filter by nested objects it is currently not possible to insert them using Crash. In order to do that the CrateDB REST endpoint or a client library like crate-python has to be used.

The same also applies for arrays.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

crash-0.23.0.tar.gz (51.0 kB view details)

Uploaded Source

Built Distribution

crash-0.23.0-py2.py3-none-any.whl (64.2 kB view details)

Uploaded Python 2Python 3

File details

Details for the file crash-0.23.0.tar.gz.

File metadata

  • Download URL: crash-0.23.0.tar.gz
  • Upload date:
  • Size: 51.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for crash-0.23.0.tar.gz
Algorithm Hash digest
SHA256 3bea355b81515fae2b751a057bd6be0bdfdb3c422a131aa5a85fc3d7d0ee726d
MD5 e477a84dba29a21da10eef430f8549cf
BLAKE2b-256 31e36a2ab2b2f3bb9f8dc6f4c9345d5800372849e8607afd6be51c15d79f6de5

See more details on using hashes here.

File details

Details for the file crash-0.23.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for crash-0.23.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 2aaf53f9e652dacf219f0624616b441cf0ddb8c4ffc75b83dd13be67b51e77fc
MD5 c050f2e47d5746eb19501c8bd0580935
BLAKE2b-256 5f4c82515acec062ed9588cab12c9f96333603f46a968e012c20842d22f7be77

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page