[](https://badge.fury.io/py/cqlsh)
[](https://pepy.tech/project/cqlsh)
[](https://opensource.org/licenses/Apache-2.0)
# `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`](https://pip.pypa.io/en/stable/quickstart/):
```
$ pip install -U cqlsh
```
### Running:
```
$ cqlsh --help
```
### Documentation:
Documentation is available as part of the official [Apache Cassandra™ documentation](https://cassandra.apache.org/doc/latest/tools/cqlsh.html).
### Contributing:
Because this is a repackaging of `cqlsh` from the official [Cassandra repo](https://gitbox.apache.org/repos/asf/cassandra.git), **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](https://github.com/apache/cassandra/blob/trunk/CONTRIBUTING.md).
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
```
2. Start a local copy of Cassandra:
```
$ docker pull cassandra
$ docker run -it --rm -p 9042:9042 cassandra
```
3. 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](https://github.com/jeffwidman) and [Brad Schoening](https://github.com/bschoening). Previous maintainers: [Spiro](https://github.com/spiside) and [Andrew Mussey](https://github.com/amussey).
### 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.3 (Feburary 23, 2023)
This packages `cqlsh` `6.1.0` from [Cassandra 4.1.4](https://github.com/apache/cassandra/blob/cassandra-4.1.4/bin/cqlsh.py):
* CQLSH emits a warning when the server version doesn't match (CASSANDRA-18745)
* Fix CQLSH online help topic link (CASSANDRA-17534)
#### 6.1.2 (March 24, 2023)
This packages `cqlsh` `6.1.0` from [Cassandra 4.1.1](https://github.com/apache/cassandra/blob/cassandra-4.1.1/bin/cqlsh.py):
* Now supports Python 3.11.
* 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.1.1 (skipped due to a versioning issue)
#### 6.1.0 (Jan 4, 2023)
This packages `cqlsh` `6.1.0` from [Cassandra 4.1](https://github.com/apache/cassandra/blob/cassandra-4.1.0/bin/cqlsh.py):
* 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](https://github.com/jeffwidman/cqlsh/issues/11).
#### 6.0.0 (Aug 3, 2021)
This packages `cqlsh` `6.0.0` from [Cassandra 4.0](https://github.com/apache/cassandra/blob/cassandra-4.0.0/bin/cqlsh.py):
* 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](https://github.com/apache/cassandra/blob/cassandra-4.0-beta4/bin/cqlsh.py):
* 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](https://github.com/apache/cassandra/blob/cassandra-3.11.10/bin/cqlsh.py).
#### 5.0.4 (Mar 29, 2017)
This packages `cqlsh` `5.0.1` from [Cassandra 3.4.0](https://github.com/apache/cassandra/blob/cassandra-3.4/bin/cqlsh.py).
#### 5.0.3 (Mar 21, 2016)
This packages `cqlsh` `5.0.1` from [Cassandra 2.2.0](https://github.com/apache/cassandra/blob/cassandra-2.2.0/bin/cqlsh.py).
#### 4.1.1 (Feb 11, 2014)
This packages `cqlsh` `4.1.1` from [Cassandra 2.0.5](https://github.com/apache/cassandra/blob/cassandra-2.0.5/bin/cqlsh).
#### 4.1.0 (Dec 2, 2013)
This packages `cqlsh` `4.1.0` from [Cassandra 2.0.3](https://github.com/apache/cassandra/blob/cassandra-2.0.3/bin/cqlsh).
#### 4.0.1 (Oct 14, 2013)
This packages `cqlsh` `4.0.1` from [Cassandra 2.0.1](https://github.com/apache/cassandra/blob/cassandra-2.0.1/bin/cqlsh).
Raw data
{
"_id": null,
"home_page": "https://github.com/jeffwidman/cqlsh",
"name": "cqlsh",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "cql,cassandra,cqlsh",
"author": "Jeff Widman",
"author_email": "jeff@jeffwidman.com",
"download_url": "https://files.pythonhosted.org/packages/a4/6a/bf59ccfc91f9ccd16db28f1cd46558f2c179732af2c1d82dad650b7cff7b/cqlsh-6.1.3.tar.gz",
"platform": null,
"description": "[](https://badge.fury.io/py/cqlsh)\n\n[](https://pepy.tech/project/cqlsh)\n[](https://opensource.org/licenses/Apache-2.0)\n\n# `cqlsh`\n\n`cqlsh` is a Python-based command-line client for running `CQL` commands on a `cassandra` cluster.\n\nNormally it's packaged as part of the full Apache Cassandra\u2122 installation. This repo repackages it into a standalone Python package for lighter-weight installs.\n\n### Installing:\n\nInstall and update using [`pip`](https://pip.pypa.io/en/stable/quickstart/):\n```\n$ pip install -U cqlsh\n```\n\n### Running:\n\n```\n$ cqlsh --help\n```\n\n### Documentation:\n\nDocumentation is available as part of the official [Apache Cassandra\u2122 documentation](https://cassandra.apache.org/doc/latest/tools/cqlsh.html).\n\n### Contributing:\n\nBecause this is a repackaging of `cqlsh` from the official [Cassandra repo](https://gitbox.apache.org/repos/asf/cassandra.git), **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](https://github.com/apache/cassandra/blob/trunk/CONTRIBUTING.md).\n\nSteps to sanity check that the packaging works as expected:\n\n1. Install `cqlsh` locally (probably in a `virtualenv`):\n```\n$ pip install -e . # run from within the cqlsh directory\n```\n2. Start a local copy of Cassandra:\n```\n$ docker pull cassandra\n$ docker run -it --rm -p 9042:9042 cassandra\n```\n3. Verify `cqlsh` successfully connects to the server:\n```\n$ cqlsh\n\nConnected to Test Cluster at 127.0.0.1:9042\n[cqlsh 6.1.0 | Cassandra 4.1.0 | CQL spec 3.4.5 | Native protocol v5]\nUse HELP for help.\ncqlsh>\n```\n\nThis PyPI package is maintained by [Jeff Widman](https://github.com/jeffwidman) and [Brad Schoening](https://github.com/bschoening). Previous maintainers: [Spiro](https://github.com/spiside) and [Andrew Mussey](https://github.com/amussey).\n\n\n### Changelog:\n\nUnfortunately the Cassandra project does not always increment the `cqlsh` version number, so for every\nrelease we need to document not only the `cqlsh` version but also the `cassandra` version in which it\nshipped.\n\n#### 6.1.3 (Feburary 23, 2023)\nThis packages `cqlsh` `6.1.0` from [Cassandra 4.1.4](https://github.com/apache/cassandra/blob/cassandra-4.1.4/bin/cqlsh.py):\n * CQLSH emits a warning when the server version doesn't match (CASSANDRA-18745)\n * Fix CQLSH online help topic link (CASSANDRA-17534)\n\n#### 6.1.2 (March 24, 2023)\n\nThis packages `cqlsh` `6.1.0` from [Cassandra 4.1.1](https://github.com/apache/cassandra/blob/cassandra-4.1.1/bin/cqlsh.py):\n* Now supports Python 3.11.\n* 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.\n\n#### 6.1.1 (skipped due to a versioning issue)\n\n#### 6.1.0 (Jan 4, 2023)\n\nThis packages `cqlsh` `6.1.0` from [Cassandra 4.1](https://github.com/apache/cassandra/blob/cassandra-4.1.0/bin/cqlsh.py):\n* Requires Python 3.6+.\n* 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.\n\n#### 6.0.1 (Jan 18, 2022)\n\nThe actual source code is identical to the `cqlsh` `6.0.0` release, except it's now packaged as\na module. This allows it to be used as a library, not just an executable script. It also provides\nbetter Windows support. Details in https://github.com/jeffwidman/cqlsh/pull/7 by @bschoening.\n\nNote: This release was yanked from PyPI because it [broke Python 2 compatibility](https://github.com/jeffwidman/cqlsh/issues/11).\n\n#### 6.0.0 (Aug 3, 2021)\n\nThis packages `cqlsh` `6.0.0` from [Cassandra 4.0](https://github.com/apache/cassandra/blob/cassandra-4.0.0/bin/cqlsh.py):\n* Requires Python 3.6+ or 2.7 (although support for Python 2 is deprecated).\n* 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.\n\n\n#### 6.0.0b4 (Mar 9, 2021)\n\nThis packages `cqlsh` `5.0.1` from [Cassandra 4.0-beta4](https://github.com/apache/cassandra/blob/cassandra-4.0-beta4/bin/cqlsh.py):\n* Now supports Python 3.\n* 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.\n\n#### 5.0.5 (Mar 9, 2021)\n\nThis packages `cqlsh` `5.0.1` from [Cassandra 3.11.10](https://github.com/apache/cassandra/blob/cassandra-3.11.10/bin/cqlsh.py).\n\n#### 5.0.4 (Mar 29, 2017)\n\nThis packages `cqlsh` `5.0.1` from [Cassandra 3.4.0](https://github.com/apache/cassandra/blob/cassandra-3.4/bin/cqlsh.py).\n\n\n#### 5.0.3 (Mar 21, 2016)\n\nThis packages `cqlsh` `5.0.1` from [Cassandra 2.2.0](https://github.com/apache/cassandra/blob/cassandra-2.2.0/bin/cqlsh.py).\n\n\n#### 4.1.1 (Feb 11, 2014)\n\nThis packages `cqlsh` `4.1.1` from [Cassandra 2.0.5](https://github.com/apache/cassandra/blob/cassandra-2.0.5/bin/cqlsh).\n\n\n#### 4.1.0 (Dec 2, 2013)\n\nThis packages `cqlsh` `4.1.0` from [Cassandra 2.0.3](https://github.com/apache/cassandra/blob/cassandra-2.0.3/bin/cqlsh).\n\n\n#### 4.0.1 (Oct 14, 2013)\n\nThis packages `cqlsh` `4.0.1` from [Cassandra 2.0.1](https://github.com/apache/cassandra/blob/cassandra-2.0.1/bin/cqlsh).\n",
"bugtrack_url": null,
"license": "",
"summary": "cqlsh is a Python-based command-line client for running CQL commands on a cassandra cluster.",
"version": "6.1.3",
"project_urls": {
"Changelog": "https://github.com/jeffwidman/cqlsh#changelog",
"Documentation": "https://cassandra.apache.org/doc/latest/tools/cqlsh.html",
"Homepage": "https://github.com/jeffwidman/cqlsh"
},
"split_keywords": [
"cql",
"cassandra",
"cqlsh"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b320c426023f98ef833fa815a8893218e0fbf896717b011c260802744b387fcd",
"md5": "b8d9ae8d05f7a0fe5821128cc49aec30",
"sha256": "778a85d8720afb77fb1829d70f17fb4cf647a2db58b40b455a6443675ee20b5a"
},
"downloads": -1,
"filename": "cqlsh-6.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b8d9ae8d05f7a0fe5821128cc49aec30",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 110908,
"upload_time": "2024-03-13T03:07:22",
"upload_time_iso_8601": "2024-03-13T03:07:22.574712Z",
"url": "https://files.pythonhosted.org/packages/b3/20/c426023f98ef833fa815a8893218e0fbf896717b011c260802744b387fcd/cqlsh-6.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a46abf59ccfc91f9ccd16db28f1cd46558f2c179732af2c1d82dad650b7cff7b",
"md5": "6f58cfab50803354d93bde76cbf09428",
"sha256": "64ae565b477513db4fbdfb2c23f7cc70d9fdbdb63796e4fe258a26bc45ba39ee"
},
"downloads": -1,
"filename": "cqlsh-6.1.3.tar.gz",
"has_sig": false,
"md5_digest": "6f58cfab50803354d93bde76cbf09428",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 102988,
"upload_time": "2024-03-13T03:07:25",
"upload_time_iso_8601": "2024-03-13T03:07:25.147674Z",
"url": "https://files.pythonhosted.org/packages/a4/6a/bf59ccfc91f9ccd16db28f1cd46558f2c179732af2c1d82dad650b7cff7b/cqlsh-6.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-13 03:07:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jeffwidman",
"github_project": "cqlsh",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "cqlsh"
}
JSON
