Skip to main content

cqlsh is a Python-based command-line client for running CQL commands on a cassandra cluster.

Project description

License Downloads PyPI version

cqlsh

cqlsh is a Python-based command-line client for running CQL commands on a cassandra cluster.

Normally it's packaged as part of the full Apache Cassandra™ installation. This repo repackages it into a standalone Python package for lighter-weight installs.

Installing:

Install and update using pip:

$ pip install -U cqlsh

Running:

$ cqlsh --help

Documentation:

Documentation is available as part of the official Apache Cassandra™ documentation.

Contributing:

Because this is a repackaging of cqlsh from the official Cassandra repo, only issues / PRs related to PyPI packaging should be opened against this repo. If you would like to contribute to cqlsh itself, find out more information here.

Steps to sanity check that the packaging works as expected:

  1. Install cqlsh locally (probably in a virtualenv):
$ pip install -e .  # run from within the cqlsh directory
  1. Start a local copy of Cassandra:
$ docker pull cassandra
$ docker run -it --rm -p 9042:9042 cassandra
  1. Verify cqlsh successfully connects to the server:
$ cqlsh

Connected to Test Cluster at 127.0.0.1:9042
[cqlsh 6.1.0 | Cassandra 4.1.0 | CQL spec 3.4.5 | Native protocol v5]
Use HELP for help.
cqlsh>

This PyPI package is maintained by Jeff Widman and Brad Schoening. Previous maintainers: Spiro and Andrew Mussey.

Changelog:

Unfortunately the Cassandra project does not always increment the cqlsh version number, so for every release we need to document not only the cqlsh version but also the cassandra version in which it shipped.

6.1.0 (Jan 3, 2022)

This packages cqlsh 6.1.0 from Cassandra 4.1:

  • Requires Python 3.6+.
  • Although this is pulled from a Cassandra 4.x release, it is protocol compatible with Cassandra 3.x clusters, with the exception of DESCRIBE keywords which require a 4.x cluster.

6.0.1 (Jan 18, 2022)

The actual source code is identical to the cqlsh 6.0.0 release, except it's now packaged as a module. This allows it to be used as a library, not just an executable script. It also provides better Windows support. Details in https://github.com/jeffwidman/cqlsh/pull/7 by @bschoening.

Note: This release was yanked from PyPI because it broke Python 2 compatibility.

6.0.0 (Aug 3, 2021)

This packages cqlsh 6.0.0 from Cassandra 4.0:

  • Requires Python 3.6+ or 2.7 (although support for Python 2 is deprecated).
  • Although this is pulled from a Cassandra 4.x release, it should generally work against Cassandra 3.x clusters without needing to set any flags.

6.0.0b4 (Mar 9, 2021)

This packages cqlsh 5.0.1 from Cassandra 4.0-beta4:

  • Now supports Python 3.
  • Although this is pulled from a Cassandra 4.x release, it should generally work against Cassandra 3.x clusters without needing to set any flags.

5.0.5 (Mar 9, 2021)

This packages cqlsh 5.0.1 from Cassandra 3.11.10.

5.0.4 (Mar 29, 2017)

This packages cqlsh 5.0.1 from Cassandra 3.4.0.

5.0.3 (Mar 21, 2016)

This packages cqlsh 5.0.1 from Cassandra 2.2.0.

4.1.1 (Feb 11, 2014)

This packages cqlsh 4.1.1 from Cassandra 2.0.5.

4.1.0 (Dec 2, 2013)

This packages cqlsh 4.1.0 from Cassandra 2.0.3.

4.0.1 (Oct 14, 2013)

This packages cqlsh 4.0.1 from Cassandra 2.0.1.

Project details


Download files

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

Source Distribution

cqlsh-6.1.0.tar.gz (102.3 kB view details)

Uploaded Source

Built Distribution

cqlsh-6.1.0-py3-none-any.whl (110.3 kB view details)

Uploaded Python 3

File details

Details for the file cqlsh-6.1.0.tar.gz.

File metadata

  • Download URL: cqlsh-6.1.0.tar.gz
  • Upload date:
  • Size: 102.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.8

File hashes

Hashes for cqlsh-6.1.0.tar.gz
Algorithm Hash digest
SHA256 bc41a451fb939b1bd8c70da8dd9a39c5cb8eeb5afee5ebc0692d80c98011e5af
MD5 19fa76754a0872f8b7dff634712b51d2
BLAKE2b-256 ad086e1dd330d1928a21702cb85d54d84ca428b33cdafd0f71a5733486bebc02

See more details on using hashes here.

Provenance

File details

Details for the file cqlsh-6.1.0-py3-none-any.whl.

File metadata

  • Download URL: cqlsh-6.1.0-py3-none-any.whl
  • Upload date:
  • Size: 110.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.8

File hashes

Hashes for cqlsh-6.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fb57c2d88fbe14daadcf0b9bfd087ba783b6be32319e41b18c22c0ab7fd6582d
MD5 873105ecabd6db0c9082c399b2a50b5b
BLAKE2b-256 89e642b0a920d56af0411c47d486e031ca48519e949ea0f712ba511d056cb5f2

See more details on using hashes here.

Provenance

Supported by

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