Metadata-Version: 2.4
Name: scylla-cqlsh
Version: 6.0.36
Summary: cqlsh is a Python-based command-line client for running CQL commands on a scylla cluster.
Home-page: https://github.com/scylladb/scylla-cqlsh
Author: Israel Fruchter
Author-email: fruch@scylladb.com
License: Apache
Project-URL: Changelog, https://github.com/scylladb/scylla-cqlsh#changelog
Project-URL: Documentation, https://cassandra.apache.org/doc/latest/tools/cqlsh.html
Keywords: cql,scylladb,cassandra,cqlsh
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Topic :: Database :: Front-Ends
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: scylla-driver>=3.25.10
Requires-Dist: lz4
Dynamic: classifier
Dynamic: license
Dynamic: license-file
Dynamic: requires-dist

# scylla-cqlsh

Command line tool to connect to [scylladb](http://www.scylladb.com) (or Apache Cassandra)

A fork of the cqlsh tool from https://github.com/apache/cassandra

![Libraries.io dependency status for latest release](https://img.shields.io/librariesio/release/pypi/scylla-cqlsh)
![GitHub branch checks state](https://img.shields.io/github/checks-status/scylladb/scylla-cqlsh/master)
![PyPI](https://img.shields.io/pypi/v/scylla-cqlsh)

# Quickstart

```bash
pip install scylla-cqlsh

cqlsh ${SCYLLA_HOST} -e 'SELECT * FROM system.local'

# or just using it interactively
cqlsh ${SCYLLA_HOST} 

# running with docker image interactively
docker run -it scylladb/scylla-cqlsh ${SCYLLA_HOST}
```



# Contributing

Feel free to open a PR/issues with suggestion and improvement
Try covering you suggested change with a test, and the instruction 
for running tests are below

## Testing

Dependent 
* python 2.7/3.x (recommend virtualenv)
* minimum java8

```bash
pip install -e .
pip install -r pylib/requirements.txt

# run scylla with docker
docker run  -d scylladb/scylla:latest --cluster-name test

export DOCKER_ID=$(docker run -d scylladb/scylla:latest --cluster-name test)
export CQL_TEST_HOST=$(docker inspect --format='{{ .NetworkSettings.IPAddress }}' ${DOCKER_ID})
while ! nc -z ${CQL_TEST_HOST} 9042; do   
  sleep 0.1 # wait for 1/10 of the second before check again
done
          
 
# run scylla with CCM
ccm create cqlsh_cluster -n 1 --scylla --version unstable/master:latest
ccm start

pytest
```

## Build from source

```bash
pip install build
# optionally can disable the usage of cython
# export CQLSH_NO_CYTHON=true
python -m build -w
...
Successfully built scylla_cqlsh-6.0.24.dev0+gb09bc79361.d20240910-py3-none-any.whl
```

## Creation of the repo

A reference on how this we forked out of cassandra repo
So we can repeat the process if we want to bring change back it

```bash
git clone  -b trunk --single-branch git@github.com:apache/cassandra.git
sudo apt-get install git-filter-repo
cd cassandra

git filter-repo --path bin/cqlsh --path bin/cqlsh.py --path pylib/
```
