{"id":15659266,"url":"https://github.com/jeffwidman/cqlsh","last_synced_at":"2025-04-06T11:08:58.419Z","repository":{"id":42656861,"uuid":"345853882","full_name":"jeffwidman/cqlsh","owner":"jeffwidman","description":"Home of the cqlsh package on PyPI. Repackages the official Cassandra cqlsh for lighter-weight installs.","archived":false,"fork":false,"pushed_at":"2025-03-08T19:14:01.000Z","size":343,"stargazers_count":23,"open_issues_count":4,"forks_count":8,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-30T09:09:23.990Z","etag":null,"topics":["cassandra","cqlsh","scylla","scylladb"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jeffwidman.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-03-09T02:06:14.000Z","updated_at":"2024-11-18T04:52:54.000Z","dependencies_parsed_at":"2024-02-29T05:24:58.314Z","dependency_job_id":"8488b4e5-eaf0-47f9-bff1-e9433df874b3","html_url":"https://github.com/jeffwidman/cqlsh","commit_stats":{"total_commits":48,"total_committers":9,"mean_commits":5.333333333333333,"dds":0.5208333333333333,"last_synced_commit":"b41ee795c16c58058c8156e5b3d1d4d507b0b460"},"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeffwidman%2Fcqlsh","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeffwidman%2Fcqlsh/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeffwidman%2Fcqlsh/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeffwidman%2Fcqlsh/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jeffwidman","download_url":"https://codeload.github.com/jeffwidman/cqlsh/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247471520,"owners_count":20944158,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cassandra","cqlsh","scylla","scylladb"],"created_at":"2024-10-03T13:15:56.117Z","updated_at":"2025-04-06T11:08:58.391Z","avatar_url":"https://github.com/jeffwidman.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![PyPI version](https://badge.fury.io/py/cqlsh.svg)](https://badge.fury.io/py/cqlsh)\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/cqlsh)\n[![Downloads](https://pepy.tech/badge/cqlsh)](https://pepy.tech/project/cqlsh)\n[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](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™ 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™ 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\u003e\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.2.0 (September 16, 2024)\n\nThis packages `cqlsh` `6.2.0` from [Cassandra 5.0.0](https://github.com/apache/cassandra/blob/cassandra-5.0.0/pylib/cqlshlib):\n * Add HISTORY command for CQLSH (CASSANDRA-15046)\n * Add CQLSH command SHOW REPLICAS (CASSANDRA-17577)\n * Cassandra 5.0 has refactored all cqlsh logic to be in cqlshlib, with the new cqlshmain.py replacing behavior formerly in bin/cqlsh.py\n * Replace 'wcwidth.py' with pypi module (CASSANDRA-17287)\n\n#### 6.1.3 (Feburary 23, 2023)\n\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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjeffwidman%2Fcqlsh","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjeffwidman%2Fcqlsh","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjeffwidman%2Fcqlsh/lists"}