Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
12 changes: 11 additions & 1 deletion modules/ROOT/partials/partial-nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -50,10 +50,20 @@
** xref:commands:astra-db-create-region.adoc[]
** xref:commands:astra-db-delete-region.adoc[]
** xref:commands:astra-db-list-regions.adoc[]
** xref:commands:astra-db-list-clouds.adoc[]
** xref:commands:astra-db-list-regions-classic.adoc[]
** xref:commands:astra-db-list-regions-serverless.adoc[]
** xref:commands:astra-db-list-regions-vector.adoc[]
** xref:commands:astra-db-list-clouds.adoc[]
** xref:commands:astra-db-regions.adoc[]
*** xref:commands:astra-db-regions-classic.adoc[]
*** xref:commands:astra-db-regions-serverless.adoc[]
*** xref:commands:astra-db-regions-vector.adoc[]
** xref:commands:astra-db-endpoints.adoc[]
*** xref:commands:astra-db-endpoints-list.adoc[]
*** xref:commands:astra-db-endpoints-api.adoc[]
*** xref:commands:astra-db-endpoints-data-api.adoc[]
*** xref:commands:astra-db-endpoints-swagger.adoc[]
*** xref:commands:astra-db-endpoints-playground.adoc[]
** xref:commands:astra-db-get-endpoint-swagger.adoc[]
** xref:commands:astra-db-get-endpoint-api.adoc[]
** xref:commands:astra-db-get-endpoint-playground.adoc[]
Expand Down
2 changes: 1 addition & 1 deletion modules/commands/pages/astra-config-create.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[source,shell]
----
astra config create [-dqV] [--no-input] [--[no-]overwrite] [--[no-]spinner]
[--dump-logs[=FILE]] [-cf=PATH] [--color=WHEN] [-e=ENV]
[--color[=WHEN]] [--dump-logs[=FILE]] [-cf=PATH] [-e=ENV]
[-o=FORMAT] -t=TOKEN [NAME]

----
Expand Down
5 changes: 2 additions & 3 deletions modules/commands/pages/astra-config-delete.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,8 @@

[source,shell]
----
astra config delete [-qV] [--if-exists] [--no-input] [--[no-]spinner]
[--dump-logs[=FILE]] [-cf=PATH] [--color=WHEN] [-o=FORMAT]
[NAME]
astra config delete [-qV] [--if-exists] [--no-input] [--[no-]spinner] [--color
[=WHEN]] [--dump-logs[=FILE]] [-cf=PATH] [-o=FORMAT] [NAME]

----

Expand Down
4 changes: 2 additions & 2 deletions modules/commands/pages/astra-config-get.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

[source,shell]
----
astra config get [-qV] [--no-input] [--[no-]spinner] [--dump-logs[=FILE]]
[-cf=PATH] [--color=WHEN] [-k=KEY] [-o=FORMAT] [NAME]
astra config get [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]]
[--dump-logs[=FILE]] [-cf=PATH] [-k=KEY] [-o=FORMAT] [NAME]

----

Expand Down
4 changes: 2 additions & 2 deletions modules/commands/pages/astra-config-home-path.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

[source,shell]
----
astra config home path [-qV] [--no-input] [--[no-]spinner] [--dump-logs[=FILE]]
[--color=WHEN] [-o=FORMAT] [-p | -i]
astra config home path [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]]
[--dump-logs[=FILE]] [-o=FORMAT] [-p | -i]

----

Expand Down
4 changes: 2 additions & 2 deletions modules/commands/pages/astra-config-list.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

[source,shell]
----
astra config list [-qV] [--no-input] [--[no-]spinner] [--dump-logs[=FILE]]
[-cf=PATH] [--color=WHEN] [-e=ENV] [-o=FORMAT]
astra config list [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]]
[--dump-logs[=FILE]] [-cf=PATH] [-e=ENV] [-o=FORMAT]

----

Expand Down
4 changes: 2 additions & 2 deletions modules/commands/pages/astra-config-path.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

[source,shell]
----
astra config path [-qV] [--no-input] [--[no-]spinner] [--dump-logs[=FILE]]
[--color=WHEN] [-o=FORMAT] [-p | -i]
astra config path [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]]
[--dump-logs[=FILE]] [-o=FORMAT] [-p | -i]

----

Expand Down
4 changes: 2 additions & 2 deletions modules/commands/pages/astra-config-rename.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

[source,shell]
----
astra config rename [-qV] [--no-input] [--[no-]spinner] [--dump-logs[=FILE]]
[-cf=PATH] [--color=WHEN] [-o=FORMAT] [NAME] NAME
astra config rename [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]]
[--dump-logs[=FILE]] [-cf=PATH] [-o=FORMAT] [NAME] NAME

----

Expand Down
4 changes: 2 additions & 2 deletions modules/commands/pages/astra-config-use.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

[source,shell]
----
astra config use [-qV] [--no-input] [--[no-]spinner] [--dump-logs[=FILE]]
[-cf=PATH] [--color=WHEN] [-o=FORMAT] [NAME]
astra config use [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]]
[--dump-logs[=FILE]] [-cf=PATH] [-o=FORMAT] [NAME]

----

Expand Down
4 changes: 2 additions & 2 deletions modules/commands/pages/astra-config.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

[source,shell]
----
astra config [-qV] [--no-input] [--[no-]spinner] [--dump-logs[=FILE]]
[-cf=PATH] [--color=WHEN] [-e=ENV] [-o=FORMAT] [COMMAND]
astra config [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] [--dump-logs
[=FILE]] [-cf=PATH] [-e=ENV] [-o=FORMAT] [COMMAND]

----

Expand Down
18 changes: 10 additions & 8 deletions modules/commands/pages/astra-db-cqlsh-exec.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,12 @@

[source,shell]
----
astra db cqlsh exec [-qV] [--debug] [--no-input] [--[no-]spinner] [--dump-logs
[=FILE]] [--color=WHEN] [--connect-timeout=TIMEOUT]
[--encoding=ENCODING] [-f=FILE] [-k=KEYSPACE] [-o=FORMAT]
[-r=REGION] [--request-timeout=TIMEOUT] [[[-cf=PATH]
[-p=NAME]] | [--token=TOKEN [--env=ENV]]] [DB] [STATEMENT]
astra db cqlsh exec [-qV] [--debug] [--no-input] [--[no-]spinner] [--color
[=WHEN]] [--dump-logs[=FILE]] [-b=PATH]
[--connect-timeout=TIMEOUT] [--encoding=ENCODING]
[-k=KEYSPACE] [-o=FORMAT] [-r=REGION]
[--request-timeout=TIMEOUT] [[[-cf=PATH] [-p=NAME]] |
[--token=TOKEN [--env=ENV]]] [-e[=STATEMENT] | -f=FILE] [DB]

----

Expand All @@ -20,13 +21,14 @@ Execute CQL statements for your db using cqlsh
== Options

`DB`:: The name/ID of the Astra database to connect to
`STATEMENT`:: Execute the statement and quit
`--debug`:: Show additional debugging information
`--encoding`:: Output encoding (default: utf8)
`--connect-timeout`:: Connection timeout in seconds
`-b`, `--secure-connect-bundle`:: Path to the secure connect bundle to use for authentication instead of the database name
`-k`, `--keyspace`:: Authenticate to the given keyspace
`--request-timeout`:: Request timeout in seconds
`-r`, `--region`:: The region to use. Uses the db's default region if not specified.
`-e`, `--execute`:: Execute the statement then exit
`-f`, `--file`:: Execute commands from a CQL file, then exit

.Common Options
Expand All @@ -45,7 +47,7 @@ Execute CQL statements for your db using cqlsh
[%collapsible]
====
`-cf`, `--config-file`:: The ``.astrarc`` file to use for this command
`-p`, `--profile`:: The ``.astrarc`` profile to use for this command
`-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``.
`--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks.
`--env`:: Override the target astra environment
====
Expand All @@ -55,7 +57,7 @@ Execute CQL statements for your db using cqlsh
[source,bash]
----
# Execute a CQL statement
$ astra db cqlsh exec my_db "SELECT * FROM my_keyspace.my_table"
$ astra db cqlsh exec my_db -e "SELECT * FROM my_keyspace.my_table"

# Execute a CQL file
$ astra db cqlsh exec my_db -f script.cql
Expand Down
8 changes: 4 additions & 4 deletions modules/commands/pages/astra-db-cqlsh-path.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

[source,shell]
----
astra db cqlsh path [-qV] [--if-exists] [--no-input] [--[no-]spinner]
[--dump-logs[=FILE]] [--color=WHEN] [-o=FORMAT]
[[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]]
astra db cqlsh path [-qV] [--if-exists] [--no-input] [--[no-]spinner] [--color
[=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] [[[-cf=PATH]
[-p=NAME]] | [--token=TOKEN [--env=ENV]]]

----

Expand Down Expand Up @@ -35,7 +35,7 @@ Get the path to the currently installed cqlsh executable
[%collapsible]
====
`-cf`, `--config-file`:: The ``.astrarc`` file to use for this command
`-p`, `--profile`:: The ``.astrarc`` profile to use for this command
`-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``.
`--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks.
`--env`:: Override the target astra environment
====
Expand Down
14 changes: 8 additions & 6 deletions modules/commands/pages/astra-db-cqlsh-start.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,12 @@

[source,shell]
----
astra db cqlsh start [-qV] [--debug] [--no-input] [--[no-]spinner] [--dump-logs
[=FILE]] [--color=WHEN] [--connect-timeout=TIMEOUT]
[--encoding=ENCODING] [-k=KEYSPACE] [-o=FORMAT]
[-r=REGION] [--request-timeout=TIMEOUT] [[[-cf=PATH]
[-p=NAME]] | [--token=TOKEN [--env=ENV]]] [] [DB]
astra db cqlsh start [-qV] [--debug] [--no-input] [--[no-]spinner] [--color
[=WHEN]] [--dump-logs[=FILE]] [-b=PATH]
[--connect-timeout=TIMEOUT] [--encoding=ENCODING]
[-k=KEYSPACE] [-o=FORMAT] [-r=REGION]
[--request-timeout=TIMEOUT] [[[-cf=PATH] [-p=NAME]] |
[--token=TOKEN [--env=ENV]]] [] [DB]

----

Expand All @@ -23,6 +24,7 @@ Connect to your Astra database using cqlsh
`--debug`:: Show additional debugging information
`--encoding`:: Output encoding (default: utf8)
`--connect-timeout`:: Connection timeout in seconds
`-b`, `--secure-connect-bundle`:: Path to the secure connect bundle to use for authentication instead of the database name
`-k`, `--keyspace`:: Authenticate to the given keyspace
`--request-timeout`:: Request timeout in seconds
`-r`, `--region`:: The region to use. Uses the db's default region if not specified.
Expand All @@ -43,7 +45,7 @@ Connect to your Astra database using cqlsh
[%collapsible]
====
`-cf`, `--config-file`:: The ``.astrarc`` file to use for this command
`-p`, `--profile`:: The ``.astrarc`` profile to use for this command
`-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``.
`--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks.
`--env`:: Override the target astra environment
====
Expand Down
6 changes: 3 additions & 3 deletions modules/commands/pages/astra-db-cqlsh-version.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

[source,shell]
----
astra db cqlsh version [-qV] [--debug] [--no-input] [--[no-]spinner]
[--dump-logs[=FILE]] [--color=WHEN]
astra db cqlsh version [-qV] [--debug] [--no-input] [--[no-]spinner] [--color
[=WHEN]] [--dump-logs[=FILE]]
[--connect-timeout=TIMEOUT] [--encoding=ENCODING]
[-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN
[--env=ENV]]]
Expand Down Expand Up @@ -39,7 +39,7 @@ Display the currently installed cqlsh's version
[%collapsible]
====
`-cf`, `--config-file`:: The ``.astrarc`` file to use for this command
`-p`, `--profile`:: The ``.astrarc`` profile to use for this command
`-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``.
`--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks.
`--env`:: Override the target astra environment
====
Expand Down
2 changes: 1 addition & 1 deletion modules/commands/pages/astra-db-cqlsh.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ $ astra db cqlsh start my_db
$ astra db cqlsh start my_db -k my_keyspace

# Execute a CQL statement
$ astra db cqlsh exec my_db "SELECT * FROM my_keyspace.my_table"
$ astra db cqlsh exec my_db -e "SELECT * FROM my_keyspace.my_table"

# Execute a CQL file
$ astra db cqlsh exec my_db -f script.cql
Expand Down
4 changes: 2 additions & 2 deletions modules/commands/pages/astra-db-create-cdc.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[source,shell]
----
astra db create-cdc [-qV] [--if-not-exists] [--no-input] [--[no-]spinner]
[--dump-logs[=FILE]] [--color=WHEN] [-k=KEYSPACE]
[--color[=WHEN]] [--dump-logs[=FILE]] [-k=KEYSPACE]
[-o=FORMAT] --table=TABLE --tenant=TENANT
[--topic-partitions=PARTITIONS] [[[-cf=PATH] [-p=NAME]] |
[--token=TOKEN [--env=ENV]]] [DB]
Expand Down Expand Up @@ -42,7 +42,7 @@ Create a CDC (Change Data Capture) for a table in a specific keyspace and tenant
[%collapsible]
====
`-cf`, `--config-file`:: The ``.astrarc`` file to use for this command
`-p`, `--profile`:: The ``.astrarc`` profile to use for this command
`-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``.
`--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks.
`--env`:: Override the target astra environment
====
Expand Down
6 changes: 3 additions & 3 deletions modules/commands/pages/astra-db-create-collection.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
[source,shell]
----
astra db create-collection [-qV] [--if-not-exists] [--no-input] [--[no-]
spinner] [--dump-logs[=FILE]] -c=COLLECTION
[--color=WHEN] [-d=DIMENSION]
spinner] [--color[=WHEN]] [--dump-logs[=FILE]]
-c=COLLECTION [-d=DIMENSION]
[--default-id=DEFAULT_ID]
[--embedding-key=EMBEDDING_KEY]
[--embedding-model=EMBEDDING_MODEL]
Expand Down Expand Up @@ -55,7 +55,7 @@ Create a new Data API collection in the specified database and keyspace
[%collapsible]
====
`-cf`, `--config-file`:: The ``.astrarc`` file to use for this command
`-p`, `--profile`:: The ``.astrarc`` profile to use for this command
`-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``.
`--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks.
`--env`:: Override the target astra environment
====
Expand Down
4 changes: 2 additions & 2 deletions modules/commands/pages/astra-db-create-dotenv.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[source,shell]
----
astra db create-dotenv [-qV] [--no-input] [--[no-]overwrite] [--print] [--[no-]
spinner] [--dump-logs[=FILE]] [--color=WHEN]
spinner] [--color[=WHEN]] [--dump-logs[=FILE]]
[--file=FILE] [-k=KEYSPACE] [-o=FORMAT] [-r=REGION]
[[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]]
[--keys=KEYS[,KEYS...] [--keys=KEYS[,KEYS...]]... |
Expand Down Expand Up @@ -46,7 +46,7 @@ Create a env file to help you connect to your Astra DB instance.
[%collapsible]
====
`-cf`, `--config-file`:: The ``.astrarc`` file to use for this command
`-p`, `--profile`:: The ``.astrarc`` profile to use for this command
`-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``.
`--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks.
`--env`:: Override the target astra environment
====
Expand Down
4 changes: 2 additions & 2 deletions modules/commands/pages/astra-db-create-keyspace.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[source,shell]
----
astra db create-keyspace [-qV] [--[no-]async] [--if-not-exists] [--no-input] [--
[no-]spinner] [--dump-logs[=FILE]] [--color=WHEN]
[no-]spinner] [--color[=WHEN]] [--dump-logs[=FILE]]
-k=KEYSPACE [-o=FORMAT] [--timeout=<timeout>]
[[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]]
[DB]
Expand Down Expand Up @@ -41,7 +41,7 @@ Create a new keyspace in the specified database
[%collapsible]
====
`-cf`, `--config-file`:: The ``.astrarc`` file to use for this command
`-p`, `--profile`:: The ``.astrarc`` profile to use for this command
`-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``.
`--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks.
`--env`:: Override the target astra environment
====
Expand Down
4 changes: 2 additions & 2 deletions modules/commands/pages/astra-db-create-region.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[source,shell]
----
astra db create-region [-qV] [--[no-]async] [--if-not-exists] [--no-input] [--
[no-]spinner] [--dump-logs[=FILE]] [--color=WHEN]
[no-]spinner] [--color[=WHEN]] [--dump-logs[=FILE]]
[-o=FORMAT] -r=REGION [--timeout=<timeout>] [[[-cf=PATH]
[-p=NAME]] | [--token=TOKEN [--env=ENV]]] DB

Expand Down Expand Up @@ -40,7 +40,7 @@ Add a new region to an existing database
[%collapsible]
====
`-cf`, `--config-file`:: The ``.astrarc`` file to use for this command
`-p`, `--profile`:: The ``.astrarc`` profile to use for this command
`-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``.
`--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks.
`--env`:: Override the target astra environment
====
Expand Down
12 changes: 6 additions & 6 deletions modules/commands/pages/astra-db-create.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
[source,shell]
----
astra db create [-qV] [--[no-]async] [--no-input] [--non-vector] [--[no-]
spinner] [--dump-logs[=FILE]] [-c=CLOUD]
[--capacity-units=CAPACITY UNITS] [--color=WHEN] [-k=KEYSPACE]
[-o=FORMAT] [-r=REGION] [--tier=TIER] [--timeout=<timeout>]
[[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]]
[--if-not-exists | --allow-duplicate-names] DB
spinner] [--color[=WHEN]] [--dump-logs[=FILE]] [-c=CLOUD]
[--capacity-units=CAPACITY UNITS] [-k=KEYSPACE] [-o=FORMAT]
[-r=REGION] [--tier=TIER] [--timeout=<timeout>] [[[-cf=PATH]
[-p=NAME]] | [--token=TOKEN [--env=ENV]]] [--if-not-exists |
--allow-duplicate-names] DB

----

Expand Down Expand Up @@ -48,7 +48,7 @@ Create a new Astra database
[%collapsible]
====
`-cf`, `--config-file`:: The ``.astrarc`` file to use for this command
`-p`, `--profile`:: The ``.astrarc`` profile to use for this command
`-p`, `--profile`:: The ``.astrarc`` profile to use for this command. Can be set via ``ASTRA_PROFILE``.
`--token`:: The astra token to use for this command. Use the ``--token @file`` syntax to read the token from a file, to avoid potential leaks.
`--env`:: Override the target astra environment
====
Expand Down
Loading