Skip to main content

The Crate Data Shell

Project description

Crate.IO Test Version Downloads

Overview

This is the Crate shell called crash.

Installation

Installing via pip

To install crash via pip use the following command:

$ pip install crash

To update use:

$ pip install -U crash

If you are using python 2.6 and pip >= 1.5 you have to pass the allow-external argument:

$ pip install crash --allow-external argparse

Standalone

There is also a single file executable that includes all dependencies and can be run as long as python (>= 2.6) is available on the system.

Download Crash bundle

The bundle can then be executed using python:

python ./crash_standalone_latest

Or:

chmod +x ./crash_standalone_latest
./crash_standalone_latest

Invocation

If the package was installed using pip the shell can be started by running the command crash in a terminal.

For usage information and command line options invoke:

crash --help

Where to go from here?

to take a look at the documentation visit https://crate.io/docs/projects/crash/stable/.

Are you a Developer?

You can build Crash on your own with the latest version hosted on GitHub. To do so, please refer to DEVELOP.rst for further information.

Help & Contact

Do you have any questions? Or suggestions? We would be very happy to help you. So, feel free to swing by our IRC channel #crate on Freenode. Or for further information and official contact please visit https://crate.io/.

License

Copyright 2013-2014 CRATE Technology GmbH (“Crate”)

Licensed to CRATE Technology GmbH (“Crate”) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. Crate licenses this file to you under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

However, if you have executed another commercial license agreement with Crate these terms will supersede the license and you may use the software solely pursuant to the terms of the relevant commercial agreement.

Installation & Usage

If the package was installed using pip the shell can be started by invoking crash in a terminal.

pip install 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.

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 null.lol:4200
+----------------------+-----------+---------+-----------+-------------...-+
| server_url           | node_name | version | connected | message         |
+----------------------+-----------+---------+-----------+-------------...-+
| http://null.lol: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 null.lol:4295
+------------------------+-----------+---------+-----------+-----------...-+
| server_url             | node_name | version | connected | message       |
+------------------------+-----------+---------+-----------+-----------...-+
| http://127.0.0.1:44209 | crate     | ...     | TRUE      | OK            |
| http://null.lol: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 schema_name, table_name FROM information_schema.tables
... ORDER BY table_name;
+--------------------+-------------------+
| schema_name        | table_name        |
+--------------------+-------------------+
| sys                | cluster           |
| information_schema | columns           |
| sys                | jobs              |
| sys                | jobs_log          |
| sys                | nodes             |
| sys                | operations        |
| sys                | operations_log    |
| information_schema | routines          |
| information_schema | schemata          |
| sys                | shards            |
| information_schema | table_constraints |
| information_schema | table_partitions  |
| information_schema | tables            |
+--------------------+-------------------+
SELECT 13 rows in set (... sec)

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

cr> select x from y;
SQLActionException[Table 'y' unknown]
io.crate.exceptions.TableUnknownException: Table 'y' unknown
    at io.crate.metadata.ReferenceInfos.getTableInfoUnsafe(ReferenceInfos.java:...)
...

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 Crate 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.12.0.tar.gz (28.1 kB view details)

Uploaded Source

Built Distribution

crash-0.12.0-py2.py3-none-any.whl (31.8 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

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

File hashes

Hashes for crash-0.12.0.tar.gz
Algorithm Hash digest
SHA256 19a2c1234fcb9e3413e95bf1bc2c80c59def57dae1a2125218a1697b8529263d
MD5 38efaab9ead16723ddfec00fbc5e9d46
BLAKE2b-256 296ba91e42b518d9f2169f7bbc6e040747cf2866e48efdcf28736dd5c81ad7f6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for crash-0.12.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 e972b49407b126c9e8efad21c080a52df644296b627308d9bd2809857f6a4bfb
MD5 c89355fab526802f907921b4a0c8e723
BLAKE2b-256 76dfb325b1c83d17480ea5f4ccd2797102fbe4bc352fc401d50f021fb385f94c

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