Install the CQL shell
The CQL shell (cqlsh) is a Python-based command-line shell you can use to issue Cassandra Query Language (CQL) statements to your DataStax Enterprise (DSE) databases.
The CQL shell also provides unique cqlsh commands like DESCRIBE KEYSPACE.
There are several ways to access the CQL shell, depending on your environment:
| Environment | CQL shell | Notes |
|---|---|---|
DSE tarball installation |
A supported Python version is required |
|
DSE package installation |
A supported Python version is required |
|
DSE not installed |
A supported Python version is required |
|
DSE Docker container |
A supported Python version is required |
|
Mission Control |
No additional software is required, but you must have access to the Mission Control UI. For programmatic access, use the other methods. |
Install Python
CQL shell requires Python.
DataStax recommends Python version 3.8 to 3.13. DSE 6.9.26 or later is required to use Python 3.13. Later Python versions aren’t supported by DSE 6.9.
Use earlier versions (2.7, 3.6, or 3.7) only if required to support a legacy deployment running an early patch release of DSE 6.9 where your OS or the included cqlsh binary doesn’t support a recommended Python version.
If you have multiple Python versions installed, run cqlsh in a virtual environment that uses a supported Python version.
To verify your Python version, run python -V.
Use the bundled CQL shell
Your DSE installation automatically includes cqlsh:
-
Package installations:
cqlshis installed automatically with DSE. You can runcqlshfrom your system’s command line if it is in your system’sPATH. Otherwise, run it from thebindirectory of your DSE installation. -
Tarball installations:
cqlshis installed automatically with DSE. You can runcqlshfrom thebindirectory of your DSE installation directory. -
DSE container:
cqlshis included with the container image. You can runcqlshfrom the DSEbindirectory inside the container, or start CQL shell withdocker exec. For an example, see Attach to a container.
Install the standalone CQL shell
To install cqlsh without DSE, you need a cqlsh binary tarball.
This tarball is included with DSE tarball fix packs on IBM Fix Central.
The cqlsh binary cannot be extracted from DSE DEB/RPM packages.
Separate cqlsh binary tarballs are no longer provided; you must download the DSE tarball installation files, and then extract the standalone cqlsh binary tarball.
If you installed DSE from a tarball, you can use the cqlsh binary from your original tarball installation files.
-
Find DSE tarball fix packs on IBM Fix Central.
For compatibility, choose a fix pack version that aligns with your cluster’s DSE version.
-
Go to Fix Central.
-
In the Product selector field, begin typing
IBM DataStax Enterprise, and then select that option from the menu. -
In the Release field, select the version that you want to install.
-
Click Continue.
-
On the Identify fixes page, click Continue to use the default Browse for fixes option.
-
On the Select fixes page, select the fix pack (DSE version) you want to install, and then click Continue.
Depending on the product and version, more fix packs might be available if you set the Platform filter to All, and then click Submit.
-
If prompted, sign in with your IBMid.
An IBMid account with MFA enabled is required. If you don’t have one, create an IBMid account. If your organization uses Enterprise Federation (EF) for authentication with corporate credentials, see the IBMid EF documentation.
-
On the Download options page, select Download using your browser (HTTPS), and then click Continue.
-
Review the terms and conditions, and then click I agree to activate the download links.
-
-
Click the
dse-VERSION-tgz.ziplink to download the DSE tarball fix pack. -
Unzip the downloaded file to access the included
cqlshbinary tarball (cqlsh-VERSION-bin.tar.gz). -
Extract the
cqlshdistribution into the directory where you want to installcqlsh:tar -xzvf cqlsh-VERSION-bin.tar.gz -C /PATH/TO/INSTALL/DIRECTORY -
Optional: Validate the signatures (
cqlsh-VERSION-bin.tar.gz.ascandcqlsh-VERSION-bin.tar.gz.cosign.sig), as explained in Install DataStax Enterprise (DSE) 6.9 with a binary tarball.
