From c04ccead4c82b1319b046da0039ec38be420ebce Mon Sep 17 00:00:00 2001 From: April M <36110273+aimurphy@users.noreply.github.com> Date: Tue, 27 Oct 2026 08:41:11 -0700 Subject: [PATCH 1/5] Update cqlsh.adoc --- modules/quickstarts/pages/cqlsh.adoc | 58 +++++++++++++++++++++++----- 1 file changed, 49 insertions(+), 9 deletions(-) diff --git a/modules/quickstarts/pages/cqlsh.adoc b/modules/quickstarts/pages/cqlsh.adoc index 81e3970..098f9f5 100644 --- a/modules/quickstarts/pages/cqlsh.adoc +++ b/modules/quickstarts/pages/cqlsh.adoc @@ -9,13 +9,8 @@ This is a command line-based alternative to the embedded {cql-console} in the {a 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 and {cql-shell} for {astra-db}, see xref:astra-db-serverless:cql:develop-with-cql.adoc[]. - [#prerequisites] -== Prerequisites +== Install Python //Might be up to 3.13? The `cqlsh` commands require Python 3.8 to 3.11. @@ -46,6 +41,26 @@ Traceback (most recent call last): ImportError: cannot import name PROTOCOL_TLS ---- +== `cqlsh` connection options + +All `cqlsh` options can be specified on the command line with `astra db cqlsh` commands. +However, in addition to connection options, the {product} automatically sets connection details, authentication credentials, and other `cqlsh` options like `--color` and `--encoding`. +There is no need to set these options again unless you want to override the inherited values. + +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. +`astra db cqlsh` commands connect to the specified database using the downloaded {scb-short} and the application token in the active xref:ROOT:manage-cql.adoc#manage-configuration-profiles[{product} configuration profile] or in the `--token` option. + +To use different connection options, you can set options on the command line. +For example, to use a different {scb-short} and application token, use the `-b` and `--token` options, such as: + +[source,shell,subs="+quotes"] +---- +astra db cqlsh start **DB_ID** -b path/to/scb --token @path/to/token/file +---- + +SSL options are ignored because the {scb-short} contains the SSL configuration details. + == Start an interactive `cqlsh` session Use the `xref:commands:astra-db-cqlsh-start.adoc[]` command to start `cqlsh` in interactive mode: @@ -194,8 +209,6 @@ astra db cqlsh DB $(astra db cqlsh path) --version ``` -== A section that's just a list of links to the command references for the various `cqlsh` commands `astra` offers - == Using a `.cqlshrc` file //The following content is from the pre-IBM migration cql docs: @@ -245,4 +258,31 @@ Does Astra CLI recognize `CQLSH_*` environment variables? Does Astra CLI support cqlsh connections to AMC? If you can connect to AMC, _and_ you change the value of cqlsh's `--request-timeout` option, does Astra CLI recognize the SEARCH_INDEX_TIMEOUT environment variables? If Astra CLI supports an external cqlshrc, verify if it will allow the keyspace option in [authentication]. For ex, if the default keyspace is set elsewhere in astra cli's context. -//// \ No newline at end of file +//// + +== Command references + +* xref:commands:astra-db-cqlsh-exec.adoc[] +* xref:commands:astra-db-cqlsh-start.adoc[] +* xref:commands:astra-db-cqlsh-version.adoc[] +* xref:commands:astra-db-cqlsh-path.adoc[] +* xref:astra-db-serverless:cql:develop-with-cql.adoc[] +* xref:astra-db-serverless:cql:cqlsh/cqlsh-commands/capture.adoc[] +* xref:astra-db-serverless:cql:cqlsh/cqlsh-commands/clear.adoc[] +* xref:astra-db-serverless:cql:cqlsh/cqlsh-commands/consistency.adoc[] +* xref:astra-db-serverless:cql:cqlsh/cqlsh-commands/serial-consistency.adoc[] +* xref:astra-db-serverless:cql:cqlsh/cqlsh-commands/copy.adoc[] +* xref:astra-db-serverless:cql:cqlsh/cqlsh-commands/copy-from.adoc[] +* xref:astra-db-serverless:cql:cqlsh/cqlsh-commands/describe-cluster.adoc[] +* xref:astra-db-serverless:cql:cqlsh/cqlsh-commands/describe-schema.adoc[] +* xref:astra-db-serverless:cql:cqlsh/cqlsh-commands/describe-index.adoc[] +* xref:astra-db-serverless:cql:cqlsh/cqlsh-commands/describe-keyspace.adoc[] +* xref:astra-db-serverless:cql:cqlsh/cqlsh-commands/describe-table.adoc[] +* xref:astra-db-serverless:cql:cqlsh/cqlsh-commands/describe-type.adoc[] +* xref:astra-db-serverless:cql:cqlsh/cqlsh-commands/expand.adoc[] +* xref:astra-db-serverless:cql:cqlsh/cqlsh-commands/exit.adoc[] +* xref:astra-db-serverless:cql:cqlsh/cqlsh-commands/paging.adoc[] +* xref:astra-db-serverless:cql:cqlsh/cqlsh-commands/show.adoc[] +* xref:astra-db-serverless:cql:cqlsh/cqlsh-commands/source.adoc[] +* xref:astra-db-serverless:cql:cqlsh/cqlsh-commands/timing.adoc[] +* xref:astra-db-serverless:cql:cqlsh/cqlsh-commands/tracing.adoc[] \ No newline at end of file From 64c371786e977cba1bd2a9d487f430190b41697e Mon Sep 17 00:00:00 2001 From: April M <36110273+aimurphy@users.noreply.github.com> Date: Tue, 27 Oct 2026 08:52:48 -0700 Subject: [PATCH 2/5] Update cqlsh.adoc --- modules/quickstarts/pages/cqlsh.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/quickstarts/pages/cqlsh.adoc b/modules/quickstarts/pages/cqlsh.adoc index 098f9f5..e0672d6 100644 --- a/modules/quickstarts/pages/cqlsh.adoc +++ b/modules/quickstarts/pages/cqlsh.adoc @@ -49,7 +49,7 @@ There is no need to set these options again unless you want to override the inhe 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. -`astra db cqlsh` commands connect to the specified database using the downloaded {scb-short} and the application token in the active xref:ROOT:manage-cql.adoc#manage-configuration-profiles[{product} configuration profile] or in the `--token` option. +`astra db cqlsh` commands connect to the specified database using the downloaded {scb-short} and the application token in the active xref:ROOT:manage-cli.adoc#manage-configuration-profiles[{product} configuration profile] or in the `--token` option. To use different connection options, you can set options on the command line. For example, to use a different {scb-short} and application token, use the `-b` and `--token` options, such as: From b9885ff49728240e9a7e862200a33a8f497ff39c Mon Sep 17 00:00:00 2001 From: "April I. Murphy" <36110273+aimurphy@users.noreply.github.com> Date: Tue, 27 Oct 2026 08:58:45 -0700 Subject: [PATCH 3/5] Apply suggestion from @aimurphy --- modules/quickstarts/pages/cqlsh.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/quickstarts/pages/cqlsh.adoc b/modules/quickstarts/pages/cqlsh.adoc index e0672d6..a83edee 100644 --- a/modules/quickstarts/pages/cqlsh.adoc +++ b/modules/quickstarts/pages/cqlsh.adoc @@ -44,7 +44,7 @@ ImportError: cannot import name PROTOCOL_TLS == `cqlsh` connection options All `cqlsh` options can be specified on the command line with `astra db cqlsh` commands. -However, in addition to connection options, the {product} automatically sets connection details, authentication credentials, and other `cqlsh` options like `--color` and `--encoding`. +However, the {product} automatically sets connection details, authentication credentials, and other `cqlsh` options like `--color` and `--encoding`. There is no need to set these options again unless you want to override the inherited values. All `astra db cqlsh` commands require a database name or ID. From 9a4edcf30ee53e64c615c758deefdfe48fcc8300 Mon Sep 17 00:00:00 2001 From: April M <36110273+aimurphy@users.noreply.github.com> Date: Tue, 27 Oct 2026 09:17:43 -0700 Subject: [PATCH 4/5] Update cqlsh.adoc --- modules/quickstarts/pages/cqlsh.adoc | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/modules/quickstarts/pages/cqlsh.adoc b/modules/quickstarts/pages/cqlsh.adoc index a83edee..2c0a2f6 100644 --- a/modules/quickstarts/pages/cqlsh.adoc +++ b/modules/quickstarts/pages/cqlsh.adoc @@ -41,24 +41,24 @@ Traceback (most recent call last): ImportError: cannot import name PROTOCOL_TLS ---- -== `cqlsh` connection options - -All `cqlsh` options can be specified on the command line with `astra db cqlsh` commands. -However, the {product} automatically sets connection details, authentication credentials, and other `cqlsh` options like `--color` and `--encoding`. -There is no need to set these options again unless you want to override the inherited values. +== Connect `cqlsh` and set options 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. -`astra db cqlsh` commands connect to the specified database using the downloaded {scb-short} and the application token in the active xref:ROOT:manage-cli.adoc#manage-configuration-profiles[{product} configuration profile] or in the `--token` option. +The first time you connect to a given database, {product} downloads the database's {scb} into the {product} home directory. +`astra db cqlsh` commands connect to the specified database using the downloaded {scb-short} and the application token in the active xref:ROOT:manage-cli.adoc#manage-configuration-profiles[{product} configuration profile] or the `--token` option. -To use different connection options, you can set options on the command line. -For example, to use a different {scb-short} and application token, use the `-b` and `--token` options, such as: +To use different connection details, you can set options on the command line. +For example, to override the {scb-short} and application token, use the `-b` and `--token` options, such as: [source,shell,subs="+quotes"] ---- astra db cqlsh start **DB_ID** -b path/to/scb --token @path/to/token/file ---- +All `cqlsh` options can be specified on the command line with `astra db cqlsh` commands. +However, the {product} automatically sets connection details, authentication credentials, and other `cqlsh` options like `--color` and `--encoding`. +There is no need to set these options again unless you want to override the inherited values. + SSL options are ignored because the {scb-short} contains the SSL configuration details. == Start an interactive `cqlsh` session From 156ea4b17cc5c6ead26fd59c626a776288632420 Mon Sep 17 00:00:00 2001 From: April M <36110273+aimurphy@users.noreply.github.com> Date: Tue, 27 Oct 2026 10:20:42 -0700 Subject: [PATCH 5/5] peer review --- modules/quickstarts/pages/cqlsh.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/quickstarts/pages/cqlsh.adoc b/modules/quickstarts/pages/cqlsh.adoc index 2c0a2f6..18bda59 100644 --- a/modules/quickstarts/pages/cqlsh.adoc +++ b/modules/quickstarts/pages/cqlsh.adoc @@ -10,7 +10,7 @@ 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]`). [#prerequisites] -== Install Python +== Prerequisites //Might be up to 3.13? The `cqlsh` commands require Python 3.8 to 3.11. @@ -52,7 +52,7 @@ For example, to override the {scb-short} and application token, use the `-b` and [source,shell,subs="+quotes"] ---- -astra db cqlsh start **DB_ID** -b path/to/scb --token @path/to/token/file +astra db cqlsh start **DB_ID** -b **PATH/TO/SCB** --token @**PATH/TO/TOKEN/FILE** ---- All `cqlsh` options can be specified on the command line with `astra db cqlsh` commands.