Skip to content

DOC-5507 downloads.datastax #38

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aimurphy merged 1 commit into from
Feb 26, 2026
Merged

DOC-5507 downloads.datastax #38

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions antora.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,5 @@ asciidoc:
dsbulk-short: 'DSBulk'
cql: 'Cassandra Query Language (CQL)'
cql-shell: 'CQL shell'
cql-console: 'CQL console'
pulsar-short: 'Pulsar'
8 changes: 5 additions & 3 deletions modules/quickstarts/pages/cqlsh.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,17 @@

The {cql-shell} (`cqlsh`) is a utility that you can use to issue xref:astra@cql:reference:cql-quick-reference.adoc[{cql} commands] to your {astra-db} databases.

The {product} provides embedded `cqlsh` support by downloading and installing the `cqlsh` utility in the background and exposing it through the `xref:commands:astra-db-cqlsh.adoc[]` commands.
This can act as a convenient alternative to installing and configuring a xref:astra-db-serverless:cql:develop-with-cql.adoc#connect-to-the-cql-shell[standalone cqlsh].
The {product} provides built-in `cqlsh` support by downloading and installing the `cqlsh` utility in the background, and then exposing it through the `xref:commands:astra-db-cqlsh.adoc[]` commands.
This is a command line-based alternative to the embedded {cql-console} in the {astra-ui}.

The `cqlsh` utility isn't installed by default with the {product}.
The first time you run an `astra db cqlsh` command, the {product} downloads and installs the `cqlsh` utility into the {product} home directory (`xref:ROOT:manage-cli.adoc#file-locations[~/.astra]`).

All `astra db cqlsh` commands require a database name or ID.
The first time you connect to a specific database, {product} downloads the database's {scb} into the {product} home directory.

For more information about CQL for {astra-db}, see xref:astra-db-serverless:cql:develop-with-cql.adoc[].

[#prerequisites]
== Prerequisites

Expand Down Expand Up @@ -52,7 +54,7 @@ ImportError: cannot import name PROTOCOL_TLS
----
====

== Start an interactive cqlsh session
== Start an interactive `cqlsh` session

Use the `xref:commands:astra-db-cqlsh-start.adoc[]` command to start `cqlsh` in interactive mode:

Expand Down