The Crate Data Shell
Project description
Crash
Crash is an interactive CrateDB command line interface (CLI) SQL shell with autocompletion.
Screenshot
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?
Check StackOverflow for common problems
Chat with us on Slack
Get paid support
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.
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
Built Distribution
Hashes for crash-0.22.1-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | df9cb5fd677ecd161bc980576a42b0bbc719c72f25e83ee41193183162152ab7 |
|
| MD5 | 42e752f6934d33fd6e002459e4ceddd8 |
|
| BLAKE2b-256 | 1fa1b986e122709b4217256df5159c9bd87193b93d7231a310efb3c322ff1b1d |
