From 8d618bbfc657641271d60197405b70bebf2e98f3 Mon Sep 17 00:00:00 2001 From: Anna Stuchlik Date: Thu, 9 Nov 2023 12:27:33 +0100 Subject: [PATCH] doc: update cqlsh compatibility with Python This commit updates the cqlsh compatibility with Python to Python 3. In addition it: - Replaces "Cassandra" with "ScyllaDB" in the description of cqlsh. The previous description was outdated, as we no longer can talk about using cqlsh released with Cassandra. - Replaces occurrences of "Scylla" with "ScyllaDB". - Adds additional locations of cqlsh (Docker Hub and PyPI), as well as the link to the scylla-cqlsh repository. Closes scylladb/scylladb#16016 --- docs/cql/cqlsh.rst | 40 ++++++++++++++++++++++++---------------- 1 file changed, 24 insertions(+), 16 deletions(-) diff --git a/docs/cql/cqlsh.rst b/docs/cql/cqlsh.rst index 3ea5d40e64..dde2e418f3 100644 --- a/docs/cql/cqlsh.rst +++ b/docs/cql/cqlsh.rst @@ -6,18 +6,26 @@ CQLSh: the CQL shell -------------------- -cqlsh is a command line shell for interacting with Cassandra through CQL (the Cassandra Query Language). It is shipped -with every Cassandra package and can be found in the bin/ directory alongside the Cassandra executable. cqlsh utilizes -the Python native protocol driver and connects to the single node specified on the command line. +cqlsh is a command line shell for interacting with ScyllaDB through CQL +(the Cassandra Query Language). It is shipped with every ScyllaDB package +and can be found in the ``bin/`` directory. In addition, it is available on +`Docker Hub `_ and in +the `Python Package Index (PyPI) `_. + +cqlsh utilizes the Python native protocol driver and connects to the single +node specified on the command line. + +See the `scylla-cqlsh `_ repository +on GitHub for usage examples. Compatibility ^^^^^^^^^^^^^ -cqlsh is compatible with Python 2.7. +cqlsh is compatible with Python 3.8 - Python 3.11. -In general, a given version of cqlsh is only guaranteed to work with the version of Cassandra that it was released with. -In some cases, cqlsh may work with older or newer versions of Cassandra, but this is not officially supported. +A given version of cqlsh is only guaranteed to work with the version of ScyllaDB that it was released with. +cqlsh may work with older or newer versions of ScyllaDB without any guarantees. Optional Dependencies @@ -72,13 +80,13 @@ Options: ``/usr/bin/google-chrome-stable %s``). ``--ssl`` - Use SSL when connecting to Cassandra + Use SSL when connecting to ScyllaDB. ``-u`` ``--user`` - Username to authenticate against Cassandra with + Username to authenticate against ScyllaDB. ``-p`` ``--password`` - The password to authenticate against Cassandra with should + The password to authenticate against ScyllaDB, which should be used in conjunction with ``--user`` ``-k`` ``--keyspace`` @@ -162,17 +170,17 @@ consistency ``ALL`` is not guaranteed to be enough). SHOW VERSION ~~~~~~~~~~~~ -This command is useful if you want to check which Cassandra version is compatible with your Scylla version. +This command is useful if you want to check which Cassandra version is compatible with your ScyllaDB version. Note that the two standards are not 100% identical and this command is simply a comparison tool. -If you want to display your current Scylla Version, refer to :ref:`Check your current version of Scylla `. +If you want to display your current ScyllaDB version, refer to :ref:`Check your current version of Scylla `. The display shows: * The cqlsh tool version that you're using -* The Apache Cassandra version that your version of Scylla is most compatible with -* The CQL protocol standard that your version of Scylla is most compatible with -* The native protocol standard that your version of Scylla is most compatible with +* The Apache Cassandra version that your version of ScyllaDB is most compatible with +* The CQL protocol standard that your version of ScyllaDB is most compatible with +* The native protocol standard that your version of ScyllaDB is most compatible with Example: @@ -191,7 +199,7 @@ Returns: SHOW HOST ~~~~~~~~~ -Prints the IP address and port of the Cassandra node that cqlsh is connected to in addition to the cluster name. +Prints the IP address and port of the ScyllaDB node that cqlsh is connected to in addition to the cluster name. Example: @@ -324,7 +332,7 @@ contents of a single column are large. LOGIN ~~~~~ -Authenticate as a specified Cassandra user for the current session. +Authenticate as a specified ScyllaDB user for the current session. `Usage`::