From 06ffe9c42459f5b174e6b0009d25152aee7eb86e Mon Sep 17 00:00:00 2001 From: Eric Schneider <37347760+eric-schneider@users.noreply.github.com> Date: Wed, 28 Jan 2026 14:44:45 -0600 Subject: [PATCH] Update command reference pages for v1.0.3 --- modules/ROOT/partials/partial-nav.adoc | 12 +++- .../commands/pages/astra-config-create.adoc | 2 +- .../commands/pages/astra-config-delete.adoc | 5 +- modules/commands/pages/astra-config-get.adoc | 4 +- .../pages/astra-config-home-path.adoc | 4 +- modules/commands/pages/astra-config-list.adoc | 4 +- modules/commands/pages/astra-config-path.adoc | 4 +- .../commands/pages/astra-config-rename.adoc | 4 +- modules/commands/pages/astra-config-use.adoc | 4 +- modules/commands/pages/astra-config.adoc | 4 +- .../commands/pages/astra-db-cqlsh-exec.adoc | 18 +++--- .../commands/pages/astra-db-cqlsh-path.adoc | 8 +-- .../commands/pages/astra-db-cqlsh-start.adoc | 14 ++-- .../pages/astra-db-cqlsh-version.adoc | 6 +- modules/commands/pages/astra-db-cqlsh.adoc | 2 +- .../commands/pages/astra-db-create-cdc.adoc | 4 +- .../pages/astra-db-create-collection.adoc | 6 +- .../pages/astra-db-create-dotenv.adoc | 4 +- .../pages/astra-db-create-keyspace.adoc | 4 +- .../pages/astra-db-create-region.adoc | 4 +- modules/commands/pages/astra-db-create.adoc | 12 ++-- .../commands/pages/astra-db-delete-cdc.adoc | 11 ++-- .../pages/astra-db-delete-collection.adoc | 9 +-- .../pages/astra-db-delete-keyspace.adoc | 4 +- .../pages/astra-db-delete-region.adoc | 8 +-- .../commands/pages/astra-db-delete-table.adoc | 10 +-- modules/commands/pages/astra-db-delete.adoc | 6 +- .../pages/astra-db-describe-collection.adoc | 6 +- .../pages/astra-db-describe-table.adoc | 6 +- .../commands/pages/astra-db-download-scb.adoc | 8 +-- .../commands/pages/astra-db-dsbulk-count.adoc | 26 +++++--- .../commands/pages/astra-db-dsbulk-load.adoc | 32 ++++++---- .../commands/pages/astra-db-dsbulk-path.adoc | 8 +-- .../pages/astra-db-dsbulk-unload.adoc | 27 +++++--- .../pages/astra-db-dsbulk-version.adoc | 6 +- modules/commands/pages/astra-db-dsbulk.adoc | 13 ++++ .../pages/astra-db-endpoints-api.adoc | 56 ++++++++++++++++ .../pages/astra-db-endpoints-data-api.adoc | 56 ++++++++++++++++ .../pages/astra-db-endpoints-list.adoc | 56 ++++++++++++++++ .../pages/astra-db-endpoints-playground.adoc | 56 ++++++++++++++++ .../pages/astra-db-endpoints-swagger.adoc | 56 ++++++++++++++++ .../commands/pages/astra-db-endpoints.adoc | 33 ++++++++++ .../pages/astra-db-get-endpoint-api.adoc | 10 +-- .../astra-db-get-endpoint-playground.adoc | 14 ++-- .../pages/astra-db-get-endpoint-swagger.adoc | 14 ++-- modules/commands/pages/astra-db-get.adoc | 6 +- .../commands/pages/astra-db-list-cdcs.adoc | 6 +- .../commands/pages/astra-db-list-clouds.adoc | 6 +- .../pages/astra-db-list-collections.adoc | 6 +- .../astra-db-list-embedding-providers.adoc | 10 +-- .../pages/astra-db-list-keyspaces.adoc | 6 +- .../pages/astra-db-list-regions-classic.adoc | 23 ++----- .../astra-db-list-regions-serverless.adoc | 24 ++----- .../pages/astra-db-list-regions-vector.adoc | 23 ++----- .../commands/pages/astra-db-list-regions.adoc | 8 +-- .../commands/pages/astra-db-list-tables.adoc | 8 +-- modules/commands/pages/astra-db-list.adoc | 8 +-- .../pages/astra-db-regions-classic.adoc | 64 +++++++++++++++++++ .../pages/astra-db-regions-serverless.adoc | 64 +++++++++++++++++++ .../pages/astra-db-regions-vector.adoc | 64 +++++++++++++++++++ modules/commands/pages/astra-db-regions.adoc | 31 +++++++++ modules/commands/pages/astra-db-resume.adoc | 6 +- modules/commands/pages/astra-db-status.adoc | 6 +- .../pages/astra-db-truncate-collection.adoc | 6 +- .../pages/astra-db-truncate-table.adoc | 6 +- modules/commands/pages/astra-db.adoc | 10 +-- modules/commands/pages/astra-nuke.adoc | 2 +- modules/commands/pages/astra-org-get.adoc | 8 +-- modules/commands/pages/astra-org-id.adoc | 8 +-- modules/commands/pages/astra-org-name.adoc | 8 +-- modules/commands/pages/astra-org.adoc | 6 +- .../commands/pages/astra-pcu-associate.adoc | 4 +- modules/commands/pages/astra-pcu-create.adoc | 8 +-- modules/commands/pages/astra-pcu-delete.adoc | 4 +- .../pages/astra-pcu-disassociate.adoc | 4 +- modules/commands/pages/astra-pcu-get.adoc | 6 +- .../pages/astra-pcu-list-associations.adoc | 9 +-- modules/commands/pages/astra-pcu-list.adoc | 8 +-- modules/commands/pages/astra-pcu-park.adoc | 6 +- modules/commands/pages/astra-pcu-status.adoc | 6 +- .../pages/astra-pcu-transfer-association.adoc | 4 +- modules/commands/pages/astra-pcu-unpark.adoc | 9 +-- modules/commands/pages/astra-pcu-update.adoc | 4 +- modules/commands/pages/astra-pcu.adoc | 6 +- modules/commands/pages/astra-role-get.adoc | 8 +-- modules/commands/pages/astra-role-list.adoc | 6 +- modules/commands/pages/astra-setup.adoc | 4 +- .../pages/astra-streaming-create.adoc | 10 +-- .../pages/astra-streaming-delete.adoc | 4 +- .../commands/pages/astra-streaming-exist.adoc | 8 +-- .../commands/pages/astra-streaming-get.adoc | 8 +-- .../pages/astra-streaming-list-clouds.adoc | 9 +-- .../pages/astra-streaming-list-regions.adoc | 12 ++-- .../commands/pages/astra-streaming-list.adoc | 6 +- .../pages/astra-streaming-pulsar-path.adoc | 4 +- .../pages/astra-streaming-pulsar-shell.adoc | 6 +- .../pages/astra-streaming-pulsar-token.adoc | 9 +-- .../pages/astra-streaming-pulsar-version.adoc | 9 +-- .../pages/astra-streaming-status.adoc | 8 +-- modules/commands/pages/astra-streaming.adoc | 6 +- .../commands/pages/astra-token-create.adoc | 8 +-- .../commands/pages/astra-token-delete.adoc | 6 +- modules/commands/pages/astra-token-get.adoc | 8 +-- modules/commands/pages/astra-token-list.adoc | 6 +- modules/commands/pages/astra-token.adoc | 6 +- modules/commands/pages/astra-upgrade.adoc | 4 +- modules/commands/pages/astra-user-delete.adoc | 8 +-- modules/commands/pages/astra-user-get.adoc | 8 +-- modules/commands/pages/astra-user-invite.adoc | 6 +- modules/commands/pages/astra-user-list.adoc | 6 +- 110 files changed, 951 insertions(+), 393 deletions(-) create mode 100644 modules/commands/pages/astra-db-endpoints-api.adoc create mode 100644 modules/commands/pages/astra-db-endpoints-data-api.adoc create mode 100644 modules/commands/pages/astra-db-endpoints-list.adoc create mode 100644 modules/commands/pages/astra-db-endpoints-playground.adoc create mode 100644 modules/commands/pages/astra-db-endpoints-swagger.adoc create mode 100644 modules/commands/pages/astra-db-endpoints.adoc create mode 100644 modules/commands/pages/astra-db-regions-classic.adoc create mode 100644 modules/commands/pages/astra-db-regions-serverless.adoc create mode 100644 modules/commands/pages/astra-db-regions-vector.adoc create mode 100644 modules/commands/pages/astra-db-regions.adoc diff --git a/modules/ROOT/partials/partial-nav.adoc b/modules/ROOT/partials/partial-nav.adoc index f50d1d6..503e12d 100644 --- a/modules/ROOT/partials/partial-nav.adoc +++ b/modules/ROOT/partials/partial-nav.adoc @@ -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[] diff --git a/modules/commands/pages/astra-config-create.adoc b/modules/commands/pages/astra-config-create.adoc index 5b29ccc..52b4fce 100644 --- a/modules/commands/pages/astra-config-create.adoc +++ b/modules/commands/pages/astra-config-create.adoc @@ -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] ---- diff --git a/modules/commands/pages/astra-config-delete.adoc b/modules/commands/pages/astra-config-delete.adoc index 9e1a20c..58987f9 100644 --- a/modules/commands/pages/astra-config-delete.adoc +++ b/modules/commands/pages/astra-config-delete.adoc @@ -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] ---- diff --git a/modules/commands/pages/astra-config-get.adoc b/modules/commands/pages/astra-config-get.adoc index f163bba..9a2de01 100644 --- a/modules/commands/pages/astra-config-get.adoc +++ b/modules/commands/pages/astra-config-get.adoc @@ -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] ---- diff --git a/modules/commands/pages/astra-config-home-path.adoc b/modules/commands/pages/astra-config-home-path.adoc index f10d793..e73629f 100644 --- a/modules/commands/pages/astra-config-home-path.adoc +++ b/modules/commands/pages/astra-config-home-path.adoc @@ -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] ---- diff --git a/modules/commands/pages/astra-config-list.adoc b/modules/commands/pages/astra-config-list.adoc index d0b2df8..ffbd2ef 100644 --- a/modules/commands/pages/astra-config-list.adoc +++ b/modules/commands/pages/astra-config-list.adoc @@ -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] ---- diff --git a/modules/commands/pages/astra-config-path.adoc b/modules/commands/pages/astra-config-path.adoc index 559071f..8678aec 100644 --- a/modules/commands/pages/astra-config-path.adoc +++ b/modules/commands/pages/astra-config-path.adoc @@ -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] ---- diff --git a/modules/commands/pages/astra-config-rename.adoc b/modules/commands/pages/astra-config-rename.adoc index 3d03c8d..37cc051 100644 --- a/modules/commands/pages/astra-config-rename.adoc +++ b/modules/commands/pages/astra-config-rename.adoc @@ -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 ---- diff --git a/modules/commands/pages/astra-config-use.adoc b/modules/commands/pages/astra-config-use.adoc index d8ecba8..37444ba 100644 --- a/modules/commands/pages/astra-config-use.adoc +++ b/modules/commands/pages/astra-config-use.adoc @@ -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] ---- diff --git a/modules/commands/pages/astra-config.adoc b/modules/commands/pages/astra-config.adoc index 631e7a0..ae68df8 100644 --- a/modules/commands/pages/astra-config.adoc +++ b/modules/commands/pages/astra-config.adoc @@ -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] ---- diff --git a/modules/commands/pages/astra-db-cqlsh-exec.adoc b/modules/commands/pages/astra-db-cqlsh-exec.adoc index 31d599b..34511bb 100644 --- a/modules/commands/pages/astra-db-cqlsh-exec.adoc +++ b/modules/commands/pages/astra-db-cqlsh-exec.adoc @@ -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] ---- @@ -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 @@ -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 ==== @@ -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 diff --git a/modules/commands/pages/astra-db-cqlsh-path.adoc b/modules/commands/pages/astra-db-cqlsh-path.adoc index 940b11a..42c797d 100644 --- a/modules/commands/pages/astra-db-cqlsh-path.adoc +++ b/modules/commands/pages/astra-db-cqlsh-path.adoc @@ -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]]] ---- @@ -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 ==== diff --git a/modules/commands/pages/astra-db-cqlsh-start.adoc b/modules/commands/pages/astra-db-cqlsh-start.adoc index fe2a0dd..3a9b036 100644 --- a/modules/commands/pages/astra-db-cqlsh-start.adoc +++ b/modules/commands/pages/astra-db-cqlsh-start.adoc @@ -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] ---- @@ -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. @@ -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 ==== diff --git a/modules/commands/pages/astra-db-cqlsh-version.adoc b/modules/commands/pages/astra-db-cqlsh-version.adoc index 5255698..35565e0 100644 --- a/modules/commands/pages/astra-db-cqlsh-version.adoc +++ b/modules/commands/pages/astra-db-cqlsh-version.adoc @@ -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]]] @@ -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 ==== diff --git a/modules/commands/pages/astra-db-cqlsh.adoc b/modules/commands/pages/astra-db-cqlsh.adoc index b439a0e..6905374 100644 --- a/modules/commands/pages/astra-db-cqlsh.adoc +++ b/modules/commands/pages/astra-db-cqlsh.adoc @@ -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 diff --git a/modules/commands/pages/astra-db-create-cdc.adoc b/modules/commands/pages/astra-db-create-cdc.adoc index 4920ef1..ed9195b 100644 --- a/modules/commands/pages/astra-db-create-cdc.adoc +++ b/modules/commands/pages/astra-db-create-cdc.adoc @@ -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] @@ -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 ==== diff --git a/modules/commands/pages/astra-db-create-collection.adoc b/modules/commands/pages/astra-db-create-collection.adoc index 99c62f2..aaa7699 100644 --- a/modules/commands/pages/astra-db-create-collection.adoc +++ b/modules/commands/pages/astra-db-create-collection.adoc @@ -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] @@ -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 ==== diff --git a/modules/commands/pages/astra-db-create-dotenv.adoc b/modules/commands/pages/astra-db-create-dotenv.adoc index bc4d58d..8ebf165 100644 --- a/modules/commands/pages/astra-db-create-dotenv.adoc +++ b/modules/commands/pages/astra-db-create-dotenv.adoc @@ -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...]]... | @@ -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 ==== diff --git a/modules/commands/pages/astra-db-create-keyspace.adoc b/modules/commands/pages/astra-db-create-keyspace.adoc index 21f2aa6..76c6a04 100644 --- a/modules/commands/pages/astra-db-create-keyspace.adoc +++ b/modules/commands/pages/astra-db-create-keyspace.adoc @@ -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=] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [DB] @@ -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 ==== diff --git a/modules/commands/pages/astra-db-create-region.adoc b/modules/commands/pages/astra-db-create-region.adoc index 57ed657..4104746 100644 --- a/modules/commands/pages/astra-db-create-region.adoc +++ b/modules/commands/pages/astra-db-create-region.adoc @@ -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=] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] DB @@ -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 ==== diff --git a/modules/commands/pages/astra-db-create.adoc b/modules/commands/pages/astra-db-create.adoc index 6004e4d..4f91474 100644 --- a/modules/commands/pages/astra-db-create.adoc +++ b/modules/commands/pages/astra-db-create.adoc @@ -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=] - [[[-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=] [[[-cf=PATH] + [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [--if-not-exists | + --allow-duplicate-names] DB ---- @@ -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 ==== diff --git a/modules/commands/pages/astra-db-delete-cdc.adoc b/modules/commands/pages/astra-db-delete-cdc.adoc index 9dd1e57..d532cae 100644 --- a/modules/commands/pages/astra-db-delete-cdc.adoc +++ b/modules/commands/pages/astra-db-delete-cdc.adoc @@ -2,11 +2,10 @@ [source,shell] ---- -astra db delete-cdc [-qV] [--if-exists] [--no-input] [--[no-]spinner] - [--dump-logs[=FILE]] [--color=WHEN] [-o=FORMAT] - [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] - (--cdc-id=CDC_ID | [-k=KEYSPACE --table=TABLE - --tenant=TENANT]) [DB] +astra db delete-cdc [-qV] [--if-exists] [--no-input] [--[no-]spinner] [--color + [=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] [[[-cf=PATH] + [-p=NAME]] | [--token=TOKEN [--env=ENV]]] (--cdc-id=CDC_ID + | [-k=KEYSPACE --table=TABLE --tenant=TENANT]) [DB] ---- @@ -42,7 +41,7 @@ Delete a CDC (Change Data Capture) from the 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 ==== diff --git a/modules/commands/pages/astra-db-delete-collection.adoc b/modules/commands/pages/astra-db-delete-collection.adoc index b357bb6..c3f5a8d 100644 --- a/modules/commands/pages/astra-db-delete-collection.adoc +++ b/modules/commands/pages/astra-db-delete-collection.adoc @@ -3,9 +3,10 @@ [source,shell] ---- astra db delete-collection [-qV] [--if-exists] [--no-input] [--[no-]spinner] - [--dump-logs[=FILE]] [-c=COLLECTION] [--color=WHEN] - [-k=KEYSPACE] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | - [--token=TOKEN [--env=ENV]]] [DB] + [--color[=WHEN]] [--dump-logs[=FILE]] + [-c=COLLECTION] [-k=KEYSPACE] [-o=FORMAT] + [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN + [--env=ENV]]] [DB] ---- @@ -39,7 +40,7 @@ Delete an existing Data API collection from 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 ==== diff --git a/modules/commands/pages/astra-db-delete-keyspace.adoc b/modules/commands/pages/astra-db-delete-keyspace.adoc index a99235f..409fa90 100644 --- a/modules/commands/pages/astra-db-delete-keyspace.adoc +++ b/modules/commands/pages/astra-db-delete-keyspace.adoc @@ -3,7 +3,7 @@ [source,shell] ---- astra db delete-keyspace [-qV] [--[no-]async] [--if-exists] [--no-input] [-- - [no-]spinner] [--dump-logs[=FILE]] [--color=WHEN] + [no-]spinner] [--color[=WHEN]] [--dump-logs[=FILE]] [-k=KEYSPACE] [-o=FORMAT] [--timeout=] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [DB] @@ -41,7 +41,7 @@ Delete a keyspace from 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 ==== diff --git a/modules/commands/pages/astra-db-delete-region.adoc b/modules/commands/pages/astra-db-delete-region.adoc index 557195f..6ec0fc5 100644 --- a/modules/commands/pages/astra-db-delete-region.adoc +++ b/modules/commands/pages/astra-db-delete-region.adoc @@ -3,9 +3,9 @@ [source,shell] ---- astra db delete-region [-qV] [--[no-]async] [--if-exists] [--no-input] [--[no-] - spinner] [--dump-logs[=FILE]] [--color=WHEN] [-o=FORMAT] - -r=REGION [--timeout=] [[[-cf=PATH] [-p=NAME]] - | [--token=TOKEN [--env=ENV]]] DB + spinner] [--color[=WHEN]] [--dump-logs[=FILE]] + [-o=FORMAT] -r=REGION [--timeout=] [[[-cf=PATH] + [-p=NAME]] | [--token=TOKEN [--env=ENV]]] DB ---- @@ -40,7 +40,7 @@ Delete a region from 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 ==== diff --git a/modules/commands/pages/astra-db-delete-table.adoc b/modules/commands/pages/astra-db-delete-table.adoc index b893560..0508779 100644 --- a/modules/commands/pages/astra-db-delete-table.adoc +++ b/modules/commands/pages/astra-db-delete-table.adoc @@ -2,10 +2,10 @@ [source,shell] ---- -astra db delete-table [-qV] [--if-exists] [--no-input] [--[no-]spinner] - [--dump-logs[=FILE]] [--color=WHEN] [-k=KEYSPACE] - [-o=FORMAT] [-t=TABLE] [[[-cf=PATH] [-p=NAME]] | - [--token=TOKEN [--env=ENV]]] [DB] +astra db delete-table [-qV] [--if-exists] [--no-input] [--[no-]spinner] [--color + [=WHEN]] [--dump-logs[=FILE]] [-k=KEYSPACE] [-o=FORMAT] + [-t=TABLE] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN + [--env=ENV]]] [DB] ---- @@ -39,7 +39,7 @@ Delete an existing table from 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 ==== diff --git a/modules/commands/pages/astra-db-delete.adoc b/modules/commands/pages/astra-db-delete.adoc index 58b91ee..8d84b47 100644 --- a/modules/commands/pages/astra-db-delete.adoc +++ b/modules/commands/pages/astra-db-delete.adoc @@ -3,7 +3,7 @@ [source,shell] ---- astra db delete [-qV] [--[no-]async] [--if-exists] [--no-input] [--[no-] - spinner] [--yes] [--dump-logs[=FILE]] [--color=WHEN] + spinner] [--yes] [--color[=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] [--timeout=] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [DB] @@ -22,7 +22,7 @@ Delete an existing Astra database `--if-exists`:: Do not fail if database does not exist `--yes`:: Force deletion of database without prompting `--async`:: Do not wait for the database to become active -`--timeout`:: How long the command should wait for the database to become active +`--timeout`:: How long the command should wait for the database to become terminated .Common Options [%collapsible] @@ -40,7 +40,7 @@ Delete an existing 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 ==== diff --git a/modules/commands/pages/astra-db-describe-collection.adoc b/modules/commands/pages/astra-db-describe-collection.adoc index 6b5ba7e..62d1b72 100644 --- a/modules/commands/pages/astra-db-describe-collection.adoc +++ b/modules/commands/pages/astra-db-describe-collection.adoc @@ -2,8 +2,8 @@ [source,shell] ---- -astra db describe-collection [-qV] [--no-input] [--[no-]spinner] [--dump-logs - [=FILE]] [-c=COLLECTION] [--color=WHEN] +astra db describe-collection [-qV] [--no-input] [--[no-]spinner] [--color + [=WHEN]] [--dump-logs[=FILE]] [-c=COLLECTION] [-k=KEYSPACE] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [DB] @@ -38,7 +38,7 @@ Describe an existing Data API collection with detailed information including vec [%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 ==== diff --git a/modules/commands/pages/astra-db-describe-table.adoc b/modules/commands/pages/astra-db-describe-table.adoc index 28981c1..1dd0ee7 100644 --- a/modules/commands/pages/astra-db-describe-table.adoc +++ b/modules/commands/pages/astra-db-describe-table.adoc @@ -2,8 +2,8 @@ [source,shell] ---- -astra db describe-table [-qV] [--no-input] [--[no-]spinner] [--dump-logs - [=FILE]] [--color=WHEN] [-k=KEYSPACE] [-o=FORMAT] +astra db describe-table [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] + [--dump-logs[=FILE]] [-k=KEYSPACE] [-o=FORMAT] [-t=TABLE] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [DB] @@ -38,7 +38,7 @@ Describe an existing table with detailed information including columns and prima [%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 ==== diff --git a/modules/commands/pages/astra-db-download-scb.adoc b/modules/commands/pages/astra-db-download-scb.adoc index bee6693..597245d 100644 --- a/modules/commands/pages/astra-db-download-scb.adoc +++ b/modules/commands/pages/astra-db-download-scb.adoc @@ -2,8 +2,8 @@ [source,shell] ---- -astra db download-scb [-qV] [--no-input] [--[no-]spinner] [--dump-logs[=FILE]] - [--color=WHEN] [-f=DEST] [-o=FORMAT] [-r=REGION] +astra db download-scb [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] + [--dump-logs[=FILE]] [-f=DEST] [-o=FORMAT] [-r=REGION] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [DB] @@ -20,7 +20,7 @@ Download secure connect bundle for a database `DB`:: The name or ID of the Astra database to operate on `-r`, `--region`:: The cloud provider region to target. Defaults to the default region of the database. -`-f`, `--file`:: Destination file. Defaults to `~/.astra/scb/scb__.zip` +`-f`, `--file`:: Destination SCB file .Common Options [%collapsible] @@ -38,7 +38,7 @@ Download secure connect bundle for a 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 ==== diff --git a/modules/commands/pages/astra-db-dsbulk-count.adoc b/modules/commands/pages/astra-db-dsbulk-count.adoc index 8162701..a5c3362 100644 --- a/modules/commands/pages/astra-db-dsbulk-count.adoc +++ b/modules/commands/pages/astra-db-dsbulk-count.adoc @@ -2,12 +2,12 @@ [source,shell] ---- -astra db dsbulk count [-qV] [--no-input] [--[no-]spinner] [--dump-logs[=FILE]] - [--color=WHEN] [--encoding=ENCODING] [-k=KEYSPACE] - [--log-dir=DIRECTORY] [--max-concurrent-queries=QUERIES] - [-o=FORMAT] [-query=QUERY] [-r=REGION] [-t=TABLE] +astra db dsbulk count [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] + [--dump-logs[=FILE]] [--dsbulk-config=CONFIG_FILE] + [--encoding=ENCODING] [-k=KEYSPACE] [--log-dir=DIRECTORY] + [--max-concurrent-queries=QUERIES] [-o=FORMAT] + [-query=QUERY] [-r=REGION] [-t=TABLE] [-F=FLAGS]... [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] - [--dsbulk-config=CONFIG_FILE | -F=FLAGS [-F=FLAGS]...] [DB] ---- @@ -28,9 +28,9 @@ Count items for a table, a query `--max-concurrent-queries`:: The maximum number of concurrent queries that should be carried in parallel `--log-dir`:: Log directory for dsbulk operations `-r`, `--region`:: The region to use. Uses the db's default region if not specified. -`-query`, `--schema.query`:: Optional query to unload or count `--dsbulk-config`:: Configuration file for DSBulk loader options -`-F`, `--dsbulk-flags`:: Additional flags to pass to DSBulk loader +`-F`, `--dsbulk-flag`:: Additional flags to pass to DSBulk loader, can be specified multiple times (e.g., -F '--key1=value1' -F '--key2') +`-query`, `--schema.query`:: Optional query to unload or count .Common Options [%collapsible] @@ -48,7 +48,7 @@ Count items for a table, a query [%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 ==== @@ -57,7 +57,17 @@ Count items for a table, a query == Examples [source,bash] ---- +# Count all rows in a table +$ astra db dsbulk count my_db -k my_keyspace -t users + +# Count rows using a custom query with filtering +$ astra db dsbulk count my_db -k my_keyspace -query "SELECT * FROM orders_by_customer WHERE customer_id = 11111111-1111-1111-1111-111111111111" + +# Count with increased parallelism for large tables +$ astra db dsbulk count my_db -k my_keyspace -t products --max-concurrent-queries 32 +# Find the largest partitions using dsbulk stats flags +$ astra db dsbulk count my_db -k my_keyspace -t orders_by_customer -F '--stats.modes=partitions' -F '--stats.numPartitions=5' ---- diff --git a/modules/commands/pages/astra-db-dsbulk-load.adoc b/modules/commands/pages/astra-db-dsbulk-load.adoc index d933826..2a59294 100644 --- a/modules/commands/pages/astra-db-dsbulk-load.adoc +++ b/modules/commands/pages/astra-db-dsbulk-load.adoc @@ -3,14 +3,14 @@ [source,shell] ---- astra db dsbulk load [-qV] [--allow-missing-fields] [--dry-run] [--header] - [--no-input] [--[no-]spinner] [--dump-logs[=FILE]] - [--color=WHEN] [--delimiter=DELIMITER] - [--encoding=ENCODING] [-k=KEYSPACE] [--log-dir=DIRECTORY] - [-m=MAPPING] [--max-concurrent-queries=QUERIES] - [--max-errors=COUNT] [-o=FORMAT] [-r=REGION] - [--skip-records=COUNT] [-t=TABLE] --url=URL [[[-cf=PATH] - [-p=NAME]] | [--token=TOKEN [--env=ENV]]] - [--dsbulk-config=CONFIG_FILE | -F=FLAGS [-F=FLAGS]...] [DB] + [--no-input] [--[no-]spinner] [--color[=WHEN]] [--dump-logs + [=FILE]] [--delimiter=DELIMITER] + [--dsbulk-config=CONFIG_FILE] [--encoding=ENCODING] + [-k=KEYSPACE] [--log-dir=DIRECTORY] [-m=MAPPING] + [--max-concurrent-queries=QUERIES] [--max-errors=COUNT] + [-o=FORMAT] [-r=REGION] [--skip-records=COUNT] [-t=TABLE] + --url=URL [-F=FLAGS]... [[[-cf=PATH] [-p=NAME]] | + [--token=TOKEN [--env=ENV]]] [DB] ---- @@ -30,6 +30,8 @@ Load data leveraging DSBulk `--max-concurrent-queries`:: The maximum number of concurrent queries that should be carried in parallel `--log-dir`:: Log directory for dsbulk operations `-r`, `--region`:: The region to use. Uses the db's default region if not specified. +`--dsbulk-config`:: Configuration file for DSBulk loader options +`-F`, `--dsbulk-flag`:: Additional flags to pass to DSBulk loader, can be specified multiple times (e.g., -F '--key1=value1' -F '--key2') `--url`:: File location to load data `--delimiter`:: Character(s) use as field delimiter `-m`, `--schema.mapping`:: Field-to-column mapping to use @@ -38,8 +40,6 @@ Load data leveraging DSBulk `--max-errors`:: Maximum number of errors before aborting the operation `--dry-run`:: Enable or disable dry-run mode `--allow-missing-fields`:: Ease the mapping -`--dsbulk-config`:: Configuration file for DSBulk loader options -`-F`, `--dsbulk-flags`:: Additional flags to pass to DSBulk loader .Common Options [%collapsible] @@ -57,7 +57,7 @@ Load data leveraging DSBulk [%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 ==== @@ -66,7 +66,17 @@ Load data leveraging DSBulk == Examples [source,bash] ---- +# Load a CSV that includes a header row +$ astra db dsbulk load my_db -k my_keyspace -t customers --url dsbulk_samples/customers.csv --header + +# Load a delimited file with no header +$ astra db dsbulk load my_db -k my_keyspace -t products --url dsbulk_samples/products.psv --delimiter '|' -m '0=sku,1=name,2=category,3=price,4=inventory' + +# Map input field names to different table columns +$ astra db dsbulk load my_db -k my_keyspace -t orders_by_customer --url dsbulk_samples/orders_legacy.csv --header -m 'cust_id=customer_id,ts=order_ts,id=order_id,status=status,total_usd=total,item_count=items' --log-dir dsbulk_out/logs/load-orders +# Skip preamble lines and use a dsbulk config file +$ astra db dsbulk load my_db -k my_keyspace -t orders_by_customer --url dsbulk_samples/orders_export.csv --skip-records 1 --header --dsbulk-config dsbulk_samples/dsbulk-timestamp.conf --max-errors 25 ---- diff --git a/modules/commands/pages/astra-db-dsbulk-path.adoc b/modules/commands/pages/astra-db-dsbulk-path.adoc index 9363e03..f00458b 100644 --- a/modules/commands/pages/astra-db-dsbulk-path.adoc +++ b/modules/commands/pages/astra-db-dsbulk-path.adoc @@ -2,9 +2,9 @@ [source,shell] ---- -astra db dsbulk 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 dsbulk path [-qV] [--if-exists] [--no-input] [--[no-]spinner] [--color + [=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] [[[-cf=PATH] + [-p=NAME]] | [--token=TOKEN [--env=ENV]]] ---- @@ -35,7 +35,7 @@ Get the path to the currently installed dsbulk 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 ==== diff --git a/modules/commands/pages/astra-db-dsbulk-unload.adoc b/modules/commands/pages/astra-db-dsbulk-unload.adoc index 4da1871..9e07df7 100644 --- a/modules/commands/pages/astra-db-dsbulk-unload.adoc +++ b/modules/commands/pages/astra-db-dsbulk-unload.adoc @@ -2,16 +2,15 @@ [source,shell] ---- -astra db dsbulk unload [-qV] [--header] [--no-input] [--[no-]spinner] - [--dump-logs[=FILE]] [--color=WHEN] - [--delimiter=DELIMITER] [--encoding=ENCODING] +astra db dsbulk unload [-qV] [--header] [--no-input] [--[no-]spinner] [--color + [=WHEN]] [--dump-logs[=FILE]] [--delimiter=DELIMITER] + [--dsbulk-config=CONFIG_FILE] [--encoding=ENCODING] [-k=KEYSPACE] [--log-dir=DIRECTORY] [-m=MAPPING] [--max-concurrent-queries=QUERIES] [--max-errors=COUNT] [-o=FORMAT] [-query=QUERY] [-r=REGION] [--skip-records=COUNT] [-t=TABLE] [--url=URL] - [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] - [--dsbulk-config=CONFIG_FILE | -F=FLAGS [-F=FLAGS]...] - [DB] + [-F=FLAGS]... [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN + [--env=ENV]]] [DB] ---- @@ -31,6 +30,8 @@ Unload data leveraging DSBulk `--max-concurrent-queries`:: The maximum number of concurrent queries that should be carried in parallel `--log-dir`:: Log directory for dsbulk operations `-r`, `--region`:: The region to use. Uses the db's default region if not specified. +`--dsbulk-config`:: Configuration file for DSBulk loader options +`-F`, `--dsbulk-flag`:: Additional flags to pass to DSBulk loader, can be specified multiple times (e.g., -F '--key1=value1' -F '--key2') `--url`:: The URL or path of the resource(s) to read from or write to `--delimiter`:: Character(s) use as field delimiter `-m`, `--schema.mapping`:: Field-to-column mapping to use @@ -38,8 +39,6 @@ Unload data leveraging DSBulk `--skip-records`:: Number of records to skip from each input file before parsing `--max-errors`:: Maximum number of errors to tolerate before aborting the operation `-query`, `--schema.query`:: Optional query to unload or count -`--dsbulk-config`:: Configuration file for DSBulk loader options -`-F`, `--dsbulk-flags`:: Additional flags to pass to DSBulk loader .Common Options [%collapsible] @@ -57,7 +56,7 @@ Unload data leveraging DSBulk [%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 ==== @@ -66,7 +65,17 @@ Unload data leveraging DSBulk == Examples [source,bash] ---- +# Unload a table to a local directory +$ astra db dsbulk unload my_db -k my_keyspace -t customers --url dsbulk_out/customers --header + +# Unload selected columns with renamed output headers +$ astra db dsbulk unload my_db -k my_keyspace -t products --url dsbulk_out/products_pipe --delimiter '|' -m 'product_sku=sku,product_name=name,usd_price=price' --header + +# Unload only rows that match a query +$ astra db dsbulk unload my_db -k my_keyspace -query "SELECT * FROM orders_by_customer WHERE customer_id = 111111-1111-1111-1111-111111111111" --url dsbulk_out/orders_one_customer --header +# Unload a large table with custom output file naming and tuned paging +$ astra db dsbulk unload my_db -k my_keyspace -t orders_by_customer --url dsbulk_out/orders -F '--connector.csv.fileNameFormat=orders-%06d.csv' -F '--driver.basic.request.page-size=5000' --max-concurrent-queries 32 --header ---- diff --git a/modules/commands/pages/astra-db-dsbulk-version.adoc b/modules/commands/pages/astra-db-dsbulk-version.adoc index 6f3c7ec..5186b50 100644 --- a/modules/commands/pages/astra-db-dsbulk-version.adoc +++ b/modules/commands/pages/astra-db-dsbulk-version.adoc @@ -2,8 +2,8 @@ [source,shell] ---- -astra db dsbulk version [-qV] [--no-input] [--[no-]spinner] [--dump-logs - [=FILE]] [--color=WHEN] [-o=FORMAT] [[[-cf=PATH] +astra db dsbulk version [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] + [--dump-logs[=FILE]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] ---- @@ -34,7 +34,7 @@ Display the currently installed dsbulk'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 ==== diff --git a/modules/commands/pages/astra-db-dsbulk.adoc b/modules/commands/pages/astra-db-dsbulk.adoc index 82df9fc..9b69e37 100644 --- a/modules/commands/pages/astra-db-dsbulk.adoc +++ b/modules/commands/pages/astra-db-dsbulk.adoc @@ -27,7 +27,20 @@ Use dsbulk to interface with your Astra DB database == Examples [source,bash] ---- +# Count all rows in a database table +$ astra db dsbulk count my_db -k my_keyspace -t my_table +# Load data into a database table from a file +$ astra db dsbulk load my_db -k my_keyspace -t my_table --url my_data.csv + +# Unload a database table +$ astra db dsbulk unload my_db -k my_keyspace -t my_table + +# Display dsbulk's version information +$ astra db dsbulk version + +# Get the path to the dsbulk executable +$ astra db dsbulk path ---- diff --git a/modules/commands/pages/astra-db-endpoints-api.adoc b/modules/commands/pages/astra-db-endpoints-api.adoc new file mode 100644 index 0000000..474a8b0 --- /dev/null +++ b/modules/commands/pages/astra-db-endpoints-api.adoc @@ -0,0 +1,56 @@ += astra db endpoints api + +[source,shell] +---- +astra db endpoints api [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] + [--dump-logs[=FILE]] [-o=FORMAT] [-r=REGION] + [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] + [DB] + +---- + + +Get the API endpoint to interact with the specified database + + + + + +== Options + +`DB`:: The name or ID of the Astra database to operate on +`-r`, `--region`:: The region to use + +.Common Options +[%collapsible] +==== +`-o`, `--output`:: One of: human, json, csv +`-V`, `--verbose`:: Enable verbose logging output +`-q`, `--quiet`:: Only output essential information +`--spinner`:: Enable/disable loading spinners +`--no-input`:: Don't ask for user input (e.g. confirmation prompts) +`--color`:: One of: auto, never, always +`--dump-logs`:: Write all logs to an optionally specified file +==== + +.Connection Options +[%collapsible] +==== +`-cf`, `--config-file`:: The ``.astrarc`` file 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 +==== + + +== Examples +[source,bash] +---- +# Get the API endpoint for the database +$ astra db endpoints api mydb + +# Get the API endpoint for the database in a specific region +$ astra db endpoints api mydb --region us-east1 +---- + + diff --git a/modules/commands/pages/astra-db-endpoints-data-api.adoc b/modules/commands/pages/astra-db-endpoints-data-api.adoc new file mode 100644 index 0000000..7614981 --- /dev/null +++ b/modules/commands/pages/astra-db-endpoints-data-api.adoc @@ -0,0 +1,56 @@ += astra db endpoints data-api + +[source,shell] +---- +astra db endpoints data-api [-qV] [--no-input] [--[no-]spinner] [--color + [=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] + [-r=REGION] [[[-cf=PATH] [-p=NAME]] | + [--token=TOKEN [--env=ENV]]] [DB] + +---- + + +Get the Data API endpoint for the specified database + + + + + +== Options + +`DB`:: The name or ID of the Astra database to operate on +`-r`, `--region`:: The region to use + +.Common Options +[%collapsible] +==== +`-o`, `--output`:: One of: human, json, csv +`-V`, `--verbose`:: Enable verbose logging output +`-q`, `--quiet`:: Only output essential information +`--spinner`:: Enable/disable loading spinners +`--no-input`:: Don't ask for user input (e.g. confirmation prompts) +`--color`:: One of: auto, never, always +`--dump-logs`:: Write all logs to an optionally specified file +==== + +.Connection Options +[%collapsible] +==== +`-cf`, `--config-file`:: The ``.astrarc`` file 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 +==== + + +== Examples +[source,bash] +---- +# Get the Data API endpoint for the database +$ astra db endpoints data-api mydb + +# Get the Data API endpoint for the database in a specific region +$ astra db endpoints data-api mydb --region us-east1 +---- + + diff --git a/modules/commands/pages/astra-db-endpoints-list.adoc b/modules/commands/pages/astra-db-endpoints-list.adoc new file mode 100644 index 0000000..1f71f24 --- /dev/null +++ b/modules/commands/pages/astra-db-endpoints-list.adoc @@ -0,0 +1,56 @@ += astra db endpoints list + +[source,shell] +---- +astra db endpoints list [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] + [--dump-logs[=FILE]] [-o=FORMAT] [-r=REGION] + [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] + [DB] + +---- + + +Get the various endpoints for a database + + + + + +== Options + +`DB`:: The name or ID of the Astra database to operate on +`-r`, `--region`:: The region to use + +.Common Options +[%collapsible] +==== +`-o`, `--output`:: One of: human, json, csv +`-V`, `--verbose`:: Enable verbose logging output +`-q`, `--quiet`:: Only output essential information +`--spinner`:: Enable/disable loading spinners +`--no-input`:: Don't ask for user input (e.g. confirmation prompts) +`--color`:: One of: auto, never, always +`--dump-logs`:: Write all logs to an optionally specified file +==== + +.Connection Options +[%collapsible] +==== +`-cf`, `--config-file`:: The ``.astrarc`` file 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 +==== + + +== Examples +[source,bash] +---- +# List the various endpoints for the specified database +$ astra db endpoints list my_db + +# List the various endpoints for a prompted db +$ astra db endpoints list +---- + + diff --git a/modules/commands/pages/astra-db-endpoints-playground.adoc b/modules/commands/pages/astra-db-endpoints-playground.adoc new file mode 100644 index 0000000..229ca83 --- /dev/null +++ b/modules/commands/pages/astra-db-endpoints-playground.adoc @@ -0,0 +1,56 @@ += astra db endpoints playground + +[source,shell] +---- +astra db endpoints playground [-qV] [--no-input] [--[no-]spinner] [--color + [=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] + [-r=REGION] [[[-cf=PATH] [-p=NAME]] | + [--token=TOKEN [--env=ENV]]] [DB] + +---- + + +Get the GraphQL Playground for the specified database + + + + + +== Options + +`DB`:: The name or ID of the Astra database to operate on +`-r`, `--region`:: The region to use + +.Common Options +[%collapsible] +==== +`-o`, `--output`:: One of: human, json, csv +`-V`, `--verbose`:: Enable verbose logging output +`-q`, `--quiet`:: Only output essential information +`--spinner`:: Enable/disable loading spinners +`--no-input`:: Don't ask for user input (e.g. confirmation prompts) +`--color`:: One of: auto, never, always +`--dump-logs`:: Write all logs to an optionally specified file +==== + +.Connection Options +[%collapsible] +==== +`-cf`, `--config-file`:: The ``.astrarc`` file 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 +==== + + +== Examples +[source,bash] +---- +# Get the GraphQL Playground for the database +$ astra db endpoints playground mydb + +# Get the GraphQL Playground for the database in a specific region +$ astra db endpoints playground mydb --region us-east1 +---- + + diff --git a/modules/commands/pages/astra-db-endpoints-swagger.adoc b/modules/commands/pages/astra-db-endpoints-swagger.adoc new file mode 100644 index 0000000..ad09f80 --- /dev/null +++ b/modules/commands/pages/astra-db-endpoints-swagger.adoc @@ -0,0 +1,56 @@ += astra db endpoints swagger + +[source,shell] +---- +astra db endpoints swagger [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] + [--dump-logs[=FILE]] [-o=FORMAT] [-r=REGION] + [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN + [--env=ENV]]] [DB] + +---- + + +Get the SwaggerUI endpoint for the specified database + + + + + +== Options + +`DB`:: The name or ID of the Astra database to operate on +`-r`, `--region`:: The region to use + +.Common Options +[%collapsible] +==== +`-o`, `--output`:: One of: human, json, csv +`-V`, `--verbose`:: Enable verbose logging output +`-q`, `--quiet`:: Only output essential information +`--spinner`:: Enable/disable loading spinners +`--no-input`:: Don't ask for user input (e.g. confirmation prompts) +`--color`:: One of: auto, never, always +`--dump-logs`:: Write all logs to an optionally specified file +==== + +.Connection Options +[%collapsible] +==== +`-cf`, `--config-file`:: The ``.astrarc`` file 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 +==== + + +== Examples +[source,bash] +---- +# Get the SwaggerUI endpoint for the database +$ astra db endpoints swagger mydb + +# Get the SwaggerUI endpoint for the database in a specific region +$ astra db endpoints swagger mydb --region us-east1 +---- + + diff --git a/modules/commands/pages/astra-db-endpoints.adoc b/modules/commands/pages/astra-db-endpoints.adoc new file mode 100644 index 0000000..39df740 --- /dev/null +++ b/modules/commands/pages/astra-db-endpoints.adoc @@ -0,0 +1,33 @@ += astra db endpoints + +[source,shell] +---- +astra db endpoints [COMMAND] + +---- + + +Get various endpoints for your database + + + +== Subcommands + +* xref:astra-db-endpoints-list.adoc[astra db endpoints list] +* xref:astra-db-endpoints-api.adoc[astra db endpoints api] +* xref:astra-db-endpoints-data-api.adoc[astra db endpoints data-api] +* xref:astra-db-endpoints-swagger.adoc[astra db endpoints swagger] +* xref:astra-db-endpoints-playground.adoc[astra db endpoints playground] + + +== Options + + + +== Examples +[source,bash] +---- + +---- + + diff --git a/modules/commands/pages/astra-db-get-endpoint-api.adoc b/modules/commands/pages/astra-db-get-endpoint-api.adoc index 9445926..e8005f8 100644 --- a/modules/commands/pages/astra-db-get-endpoint-api.adoc +++ b/modules/commands/pages/astra-db-get-endpoint-api.adoc @@ -2,8 +2,8 @@ [source,shell] ---- -astra db get-endpoint-api [-qV] [--no-input] [--[no-]spinner] [--dump-logs - [=FILE]] [--color=WHEN] [-o=FORMAT] [-r=REGION] +astra db get-endpoint-api [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] + [--dump-logs[=FILE]] [-o=FORMAT] [-r=REGION] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [DB] @@ -37,7 +37,7 @@ Get the API endpoint to interact with 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 ==== @@ -46,11 +46,7 @@ Get the API endpoint to interact with the specified database == Examples [source,bash] ---- -# Get the API endpoint for the database -$ astra db get-endpoint-api mydb -# Get the API endpoint for the database in a specific region -$ astra db get-endpoint-api mydb --region us-east1 ---- diff --git a/modules/commands/pages/astra-db-get-endpoint-playground.adoc b/modules/commands/pages/astra-db-get-endpoint-playground.adoc index 0d6f18e..170ef9d 100644 --- a/modules/commands/pages/astra-db-get-endpoint-playground.adoc +++ b/modules/commands/pages/astra-db-get-endpoint-playground.adoc @@ -2,10 +2,10 @@ [source,shell] ---- -astra db get-endpoint-playground [-qV] [--no-input] [--[no-]spinner] - [--dump-logs[=FILE]] [--color=WHEN] - [-o=FORMAT] [-r=REGION] [[[-cf=PATH] - [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [DB] +astra db get-endpoint-playground [-qV] [--no-input] [--[no-]spinner] [--color + [=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] + [-r=REGION] [[[-cf=PATH] [-p=NAME]] | + [--token=TOKEN [--env=ENV]]] [DB] ---- @@ -37,7 +37,7 @@ Get the GraphQL Playground for 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 ==== @@ -46,11 +46,7 @@ Get the GraphQL Playground for the specified database == Examples [source,bash] ---- -# Get the GraphQL Playground for the database -$ astra db get-endpoint-playground mydb -# Get the GraphQL Playground for the database in a specific region -$ astra db get-endpoint-playground mydb --region us-east1 ---- diff --git a/modules/commands/pages/astra-db-get-endpoint-swagger.adoc b/modules/commands/pages/astra-db-get-endpoint-swagger.adoc index d2f9260..1d52372 100644 --- a/modules/commands/pages/astra-db-get-endpoint-swagger.adoc +++ b/modules/commands/pages/astra-db-get-endpoint-swagger.adoc @@ -2,10 +2,10 @@ [source,shell] ---- -astra db get-endpoint-swagger [-qV] [--no-input] [--[no-]spinner] [--dump-logs - [=FILE]] [--color=WHEN] [-o=FORMAT] [-r=REGION] - [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN - [--env=ENV]]] [DB] +astra db get-endpoint-swagger [-qV] [--no-input] [--[no-]spinner] [--color + [=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] + [-r=REGION] [[[-cf=PATH] [-p=NAME]] | + [--token=TOKEN [--env=ENV]]] [DB] ---- @@ -37,7 +37,7 @@ Get the SwaggerUI endpoint for 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 ==== @@ -46,11 +46,7 @@ Get the SwaggerUI endpoint for the specified database == Examples [source,bash] ---- -# Get the SwaggerUI endpoint for the database -$ astra db get-endpoint-swagger mydb -# Get the SwaggerUI endpoint for the database in a specific region -$ astra db get-endpoint-swagger mydb --region us-east1 ---- diff --git a/modules/commands/pages/astra-db-get.adoc b/modules/commands/pages/astra-db-get.adoc index 913e553..4245e26 100644 --- a/modules/commands/pages/astra-db-get.adoc +++ b/modules/commands/pages/astra-db-get.adoc @@ -2,8 +2,8 @@ [source,shell] ---- -astra db get [-qV] [--no-input] [--[no-]spinner] [--dump-logs[=FILE]] - [--color=WHEN] [-k=KEY] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | +astra db get [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] [--dump-logs + [=FILE]] [-k=KEY] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [DB] ---- @@ -39,7 +39,7 @@ Get information about a specific 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 ==== diff --git a/modules/commands/pages/astra-db-list-cdcs.adoc b/modules/commands/pages/astra-db-list-cdcs.adoc index 26c39c9..362572a 100644 --- a/modules/commands/pages/astra-db-list-cdcs.adoc +++ b/modules/commands/pages/astra-db-list-cdcs.adoc @@ -2,8 +2,8 @@ [source,shell] ---- -astra db list-cdcs [-qV] [--no-input] [--[no-]spinner] [--dump-logs[=FILE]] - [--color=WHEN] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | +astra db list-cdcs [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] + [--dump-logs[=FILE]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [DB] ---- @@ -35,7 +35,7 @@ List all CDC (Change Data Capture) connections for 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 ==== diff --git a/modules/commands/pages/astra-db-list-clouds.adoc b/modules/commands/pages/astra-db-list-clouds.adoc index 2b7f336..cbbe01e 100644 --- a/modules/commands/pages/astra-db-list-clouds.adoc +++ b/modules/commands/pages/astra-db-list-clouds.adoc @@ -2,8 +2,8 @@ [source,shell] ---- -astra db list-clouds [-qV] [--no-input] [--[no-]spinner] [--dump-logs[=FILE]] - [--color=WHEN] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | +astra db list-clouds [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] + [--dump-logs[=FILE]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] ---- @@ -34,7 +34,7 @@ List all cloud providers with regions available for Astra DB [%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 ==== diff --git a/modules/commands/pages/astra-db-list-collections.adoc b/modules/commands/pages/astra-db-list-collections.adoc index 13badf9..6c8b8e2 100644 --- a/modules/commands/pages/astra-db-list-collections.adoc +++ b/modules/commands/pages/astra-db-list-collections.adoc @@ -2,8 +2,8 @@ [source,shell] ---- -astra db list-collections [-aqV] [--no-input] [--[no-]spinner] [--dump-logs - [=FILE]] [--color=WHEN] [-k=KEYSPACE] [-o=FORMAT] +astra db list-collections [-aqV] [--no-input] [--[no-]spinner] [--color[=WHEN]] + [--dump-logs[=FILE]] [-k=KEYSPACE] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [DB] @@ -38,7 +38,7 @@ List the collections 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 ==== diff --git a/modules/commands/pages/astra-db-list-embedding-providers.adoc b/modules/commands/pages/astra-db-list-embedding-providers.adoc index a226bed..29521dc 100644 --- a/modules/commands/pages/astra-db-list-embedding-providers.adoc +++ b/modules/commands/pages/astra-db-list-embedding-providers.adoc @@ -2,10 +2,10 @@ [source,shell] ---- -astra db list-embedding-providers [-qV] [--no-input] [--[no-]spinner] - [--dump-logs[=FILE]] [--color=WHEN] - [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | - [--token=TOKEN [--env=ENV]]] [DB] +astra db list-embedding-providers [-qV] [--no-input] [--[no-]spinner] [--color + [=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] + [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN + [--env=ENV]]] [DB] ---- @@ -36,7 +36,7 @@ Find all available embedding providers for a given 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 ==== diff --git a/modules/commands/pages/astra-db-list-keyspaces.adoc b/modules/commands/pages/astra-db-list-keyspaces.adoc index deb5117..8fa6bdd 100644 --- a/modules/commands/pages/astra-db-list-keyspaces.adoc +++ b/modules/commands/pages/astra-db-list-keyspaces.adoc @@ -2,8 +2,8 @@ [source,shell] ---- -astra db list-keyspaces [-qV] [--no-input] [--[no-]spinner] [--dump-logs - [=FILE]] [--color=WHEN] [-o=FORMAT] [[[-cf=PATH] +astra db list-keyspaces [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] + [--dump-logs[=FILE]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [DB] ---- @@ -35,7 +35,7 @@ List all keyspaces 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 ==== diff --git a/modules/commands/pages/astra-db-list-regions-classic.adoc b/modules/commands/pages/astra-db-list-regions-classic.adoc index 548c226..1c3ce0e 100644 --- a/modules/commands/pages/astra-db-list-regions-classic.adoc +++ b/modules/commands/pages/astra-db-list-regions-classic.adoc @@ -2,11 +2,12 @@ [source,shell] ---- -astra db list-regions-classic [-qV] [--no-input] [--[no-]spinner] [--dump-logs - [=FILE]] [--color=WHEN] [-o=FORMAT] [-c=FILTER[, - FILTER...]]... [-f=FILTER[,FILTER...]]... - [-z=FILTER[,FILTER...]]... [[[-cf=PATH] - [-p=NAME]] | [--token=TOKEN [--env=ENV]]] +astra db list-regions-classic [-qV] [--no-input] [--[no-]spinner] [--color + [=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] + [-c=FILTER[,FILTER...]]... [-f=FILTER[, + FILTER...]]... [-z=FILTER[,FILTER...]]... + [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN + [--env=ENV]]] ---- @@ -39,7 +40,7 @@ List all available regions for classic Astra DB databases [%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 ==== @@ -48,17 +49,7 @@ List all available regions for classic Astra DB databases == Examples [source,bash] ---- -# List all available regions for classic Astra DB databases -$ astra db list-regions-classic -# Filter by cloud provider -$ astra db list-regions-classic --cloud AWS,GCP - -# Filter by partial region name -$ astra db list-regions-classic --filter us-,ca- - -# Filter by zone -$ astra db list-regions-classic --zone Europe ---- diff --git a/modules/commands/pages/astra-db-list-regions-serverless.adoc b/modules/commands/pages/astra-db-list-regions-serverless.adoc index a035ed1..8a1b895 100644 --- a/modules/commands/pages/astra-db-list-regions-serverless.adoc +++ b/modules/commands/pages/astra-db-list-regions-serverless.adoc @@ -2,12 +2,12 @@ [source,shell] ---- -astra db list-regions-serverless [-qV] [--no-input] [--[no-]spinner] - [--dump-logs[=FILE]] [--color=WHEN] - [-o=FORMAT] [-c=FILTER[,FILTER...]]... - [-f=FILTER[,FILTER...]]... [-z=FILTER[, - FILTER...]]... [[[-cf=PATH] [-p=NAME]] | - [--token=TOKEN [--env=ENV]]] +astra db list-regions-serverless [-qV] [--no-input] [--[no-]spinner] [--color + [=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] + [-c=FILTER[,FILTER...]]... [-f=FILTER[, + FILTER...]]... [-z=FILTER[,FILTER...]]... + [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN + [--env=ENV]]] ---- @@ -40,7 +40,7 @@ List all available regions for serverless Astra DB databases [%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 ==== @@ -49,17 +49,7 @@ List all available regions for serverless Astra DB databases == Examples [source,bash] ---- -# List all available regions for serverless Astra DB databases -$ astra db list-regions-serverless -# Filter by cloud provider -$ astra db list-regions-serverless --cloud AWS,GCP - -# Filter by partial region name -$ astra db list-regions-serverless --filter us-,ca- - -# Filter by zone -$ astra db list-regions-serverless --zone Europe ---- diff --git a/modules/commands/pages/astra-db-list-regions-vector.adoc b/modules/commands/pages/astra-db-list-regions-vector.adoc index fd64863..001d474 100644 --- a/modules/commands/pages/astra-db-list-regions-vector.adoc +++ b/modules/commands/pages/astra-db-list-regions-vector.adoc @@ -2,11 +2,12 @@ [source,shell] ---- -astra db list-regions-vector [-qV] [--no-input] [--[no-]spinner] [--dump-logs - [=FILE]] [--color=WHEN] [-o=FORMAT] [-c=FILTER[, - FILTER...]]... [-f=FILTER[,FILTER...]]... - [-z=FILTER[,FILTER...]]... [[[-cf=PATH] [-p=NAME]] - | [--token=TOKEN [--env=ENV]]] +astra db list-regions-vector [-qV] [--no-input] [--[no-]spinner] [--color + [=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] + [-c=FILTER[,FILTER...]]... [-f=FILTER[, + FILTER...]]... [-z=FILTER[,FILTER...]]... + [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN + [--env=ENV]]] ---- @@ -39,7 +40,7 @@ List all available regions for vector Astra DB databases [%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 ==== @@ -48,17 +49,7 @@ List all available regions for vector Astra DB databases == Examples [source,bash] ---- -# List all available regions for vector Astra DB databases -$ astra db list-regions-vector -# Filter by cloud provider -$ astra db list-regions-vector --cloud AWS,GCP - -# Filter by partial region name -$ astra db list-regions-vector --filter us-,ca- - -# Filter by zone -$ astra db list-regions-vector --zone Europe ---- diff --git a/modules/commands/pages/astra-db-list-regions.adoc b/modules/commands/pages/astra-db-list-regions.adoc index 0793925..7e9c037 100644 --- a/modules/commands/pages/astra-db-list-regions.adoc +++ b/modules/commands/pages/astra-db-list-regions.adoc @@ -2,9 +2,9 @@ [source,shell] ---- -astra db list-regions [-qV] [--no-input] [--[no-]spinner] [--dump-logs[=FILE]] - [--color=WHEN] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | - [--token=TOKEN [--env=ENV]]] [DB] +astra db list-regions [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] + [--dump-logs[=FILE]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] + | [--token=TOKEN [--env=ENV]]] [DB] ---- @@ -35,7 +35,7 @@ List the regions for the given 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 ==== diff --git a/modules/commands/pages/astra-db-list-tables.adoc b/modules/commands/pages/astra-db-list-tables.adoc index 7fdc2be..2720b06 100644 --- a/modules/commands/pages/astra-db-list-tables.adoc +++ b/modules/commands/pages/astra-db-list-tables.adoc @@ -2,9 +2,9 @@ [source,shell] ---- -astra db list-tables [-aqV] [--no-input] [--[no-]spinner] [--dump-logs[=FILE]] - [--color=WHEN] [-k=KEYSPACE] [-o=FORMAT] [[[-cf=PATH] - [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [DB] +astra db list-tables [-aqV] [--no-input] [--[no-]spinner] [--color[=WHEN]] + [--dump-logs[=FILE]] [-k=KEYSPACE] [-o=FORMAT] + [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [DB] ---- @@ -37,7 +37,7 @@ List the tables 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 ==== diff --git a/modules/commands/pages/astra-db-list.adoc b/modules/commands/pages/astra-db-list.adoc index f85e846..aa2a99f 100644 --- a/modules/commands/pages/astra-db-list.adoc +++ b/modules/commands/pages/astra-db-list.adoc @@ -2,9 +2,9 @@ [source,shell] ---- -astra db list [-qvV] [--no-input] [--[no-]spinner] [--dump-logs[=FILE]] - [--color=WHEN] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | - [--token=TOKEN [--env=ENV]]] +astra db list [-qvV] [--no-input] [--[no-]spinner] [--color[=WHEN]] [--dump-logs + [=FILE]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN + [--env=ENV]]] ---- @@ -38,7 +38,7 @@ List your non-terminated Astra databases. [%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 ==== diff --git a/modules/commands/pages/astra-db-regions-classic.adoc b/modules/commands/pages/astra-db-regions-classic.adoc new file mode 100644 index 0000000..6e12576 --- /dev/null +++ b/modules/commands/pages/astra-db-regions-classic.adoc @@ -0,0 +1,64 @@ += astra db regions classic + +[source,shell] +---- +astra db regions classic [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] + [--dump-logs[=FILE]] [-o=FORMAT] [-c=FILTER[, + FILTER...]]... [-f=FILTER[,FILTER...]]... [-z=FILTER[, + FILTER...]]... [[[-cf=PATH] [-p=NAME]] | + [--token=TOKEN [--env=ENV]]] + +---- + + +List all available regions for classic Astra DB databases + + + + + +== Options + +`-f`, `--filter`:: Comma-separated case-insensitive partial-match filters on the region name +`-c`, `--cloud`:: Comma-separated list of cloud providers to filter on +`-z`, `--zone`:: Comma-separated list of zones to include + +.Common Options +[%collapsible] +==== +`-o`, `--output`:: One of: human, json, csv +`-V`, `--verbose`:: Enable verbose logging output +`-q`, `--quiet`:: Only output essential information +`--spinner`:: Enable/disable loading spinners +`--no-input`:: Don't ask for user input (e.g. confirmation prompts) +`--color`:: One of: auto, never, always +`--dump-logs`:: Write all logs to an optionally specified file +==== + +.Connection Options +[%collapsible] +==== +`-cf`, `--config-file`:: The ``.astrarc`` file 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 +==== + + +== Examples +[source,bash] +---- +# List all available regions for classic Astra DB databases +$ astra db regions classic + +# Filter by cloud provider +$ astra db regions classic --cloud AWS,GCP + +# Filter by partial region name +$ astra db regions classic --filter us-,ca- + +# Filter by zone +$ astra db regions classic --zone Europe +---- + + diff --git a/modules/commands/pages/astra-db-regions-serverless.adoc b/modules/commands/pages/astra-db-regions-serverless.adoc new file mode 100644 index 0000000..6b0f835 --- /dev/null +++ b/modules/commands/pages/astra-db-regions-serverless.adoc @@ -0,0 +1,64 @@ += astra db regions serverless + +[source,shell] +---- +astra db regions serverless [-qV] [--no-input] [--[no-]spinner] [--color + [=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] [-c=FILTER + [,FILTER...]]... [-f=FILTER[,FILTER...]]... + [-z=FILTER[,FILTER...]]... [[[-cf=PATH] [-p=NAME]] + | [--token=TOKEN [--env=ENV]]] + +---- + + +List all available regions for serverless Astra DB databases + + + + + +== Options + +`-f`, `--filter`:: Comma-separated case-insensitive partial-match filters on the region name +`-c`, `--cloud`:: Comma-separated list of cloud providers to filter on +`-z`, `--zone`:: Comma-separated list of zones to include + +.Common Options +[%collapsible] +==== +`-o`, `--output`:: One of: human, json, csv +`-V`, `--verbose`:: Enable verbose logging output +`-q`, `--quiet`:: Only output essential information +`--spinner`:: Enable/disable loading spinners +`--no-input`:: Don't ask for user input (e.g. confirmation prompts) +`--color`:: One of: auto, never, always +`--dump-logs`:: Write all logs to an optionally specified file +==== + +.Connection Options +[%collapsible] +==== +`-cf`, `--config-file`:: The ``.astrarc`` file 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 +==== + + +== Examples +[source,bash] +---- +# List all available regions for serverless Astra DB databases +$ astra db regions serverless + +# Filter by cloud provider +$ astra db regions serverless --cloud AWS,GCP + +# Filter by partial region name +$ astra db regions serverless --filter us-,ca- + +# Filter by zone +$ astra db regions serverless --zone Europe +---- + + diff --git a/modules/commands/pages/astra-db-regions-vector.adoc b/modules/commands/pages/astra-db-regions-vector.adoc new file mode 100644 index 0000000..11510fd --- /dev/null +++ b/modules/commands/pages/astra-db-regions-vector.adoc @@ -0,0 +1,64 @@ += astra db regions vector + +[source,shell] +---- +astra db regions vector [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] + [--dump-logs[=FILE]] [-o=FORMAT] [-c=FILTER[, + FILTER...]]... [-f=FILTER[,FILTER...]]... [-z=FILTER[, + FILTER...]]... [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN + [--env=ENV]]] + +---- + + +List all available regions for vector Astra DB databases + + + + + +== Options + +`-f`, `--filter`:: Comma-separated case-insensitive partial-match filters on the region name +`-c`, `--cloud`:: Comma-separated list of cloud providers to filter on +`-z`, `--zone`:: Comma-separated list of zones to include + +.Common Options +[%collapsible] +==== +`-o`, `--output`:: One of: human, json, csv +`-V`, `--verbose`:: Enable verbose logging output +`-q`, `--quiet`:: Only output essential information +`--spinner`:: Enable/disable loading spinners +`--no-input`:: Don't ask for user input (e.g. confirmation prompts) +`--color`:: One of: auto, never, always +`--dump-logs`:: Write all logs to an optionally specified file +==== + +.Connection Options +[%collapsible] +==== +`-cf`, `--config-file`:: The ``.astrarc`` file 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 +==== + + +== Examples +[source,bash] +---- +# List all available regions for vector Astra DB databases +$ astra db regions vector + +# Filter by cloud provider +$ astra db regions vector --cloud AWS,GCP + +# Filter by partial region name +$ astra db regions vector --filter us-,ca- + +# Filter by zone +$ astra db regions vector --zone Europe +---- + + diff --git a/modules/commands/pages/astra-db-regions.adoc b/modules/commands/pages/astra-db-regions.adoc new file mode 100644 index 0000000..ef83533 --- /dev/null +++ b/modules/commands/pages/astra-db-regions.adoc @@ -0,0 +1,31 @@ += astra db regions + +[source,shell] +---- +astra db regions [COMMAND] + +---- + + +List available regions for Astra DB databases + + + +== Subcommands + +* xref:astra-db-regions-classic.adoc[astra db regions classic] +* xref:astra-db-regions-serverless.adoc[astra db regions serverless] +* xref:astra-db-regions-vector.adoc[astra db regions vector] + + +== Options + + + +== Examples +[source,bash] +---- + +---- + + diff --git a/modules/commands/pages/astra-db-resume.adoc b/modules/commands/pages/astra-db-resume.adoc index 286d0b5..a78cdd5 100644 --- a/modules/commands/pages/astra-db-resume.adoc +++ b/modules/commands/pages/astra-db-resume.adoc @@ -2,8 +2,8 @@ [source,shell] ---- -astra db resume [-qV] [--[no-]async] [--no-input] [--[no-]spinner] [--dump-logs - [=FILE]] [--color=WHEN] [-o=FORMAT] [--timeout=] +astra db resume [-qV] [--[no-]async] [--no-input] [--[no-]spinner] [--color + [=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] [--timeout=] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [DB] ---- @@ -37,7 +37,7 @@ Resume a database that is in a stopped state. If the database is already active, [%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 ==== diff --git a/modules/commands/pages/astra-db-status.adoc b/modules/commands/pages/astra-db-status.adoc index d2eed35..916c63c 100644 --- a/modules/commands/pages/astra-db-status.adoc +++ b/modules/commands/pages/astra-db-status.adoc @@ -2,8 +2,8 @@ [source,shell] ---- -astra db status [-qV] [--no-input] [--[no-]spinner] [--dump-logs[=FILE]] - [--color=WHEN] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | +astra db status [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] + [--dump-logs[=FILE]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [DB] ---- @@ -35,7 +35,7 @@ Get the current status of a 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 ==== diff --git a/modules/commands/pages/astra-db-truncate-collection.adoc b/modules/commands/pages/astra-db-truncate-collection.adoc index 2273ba5..fc728cb 100644 --- a/modules/commands/pages/astra-db-truncate-collection.adoc +++ b/modules/commands/pages/astra-db-truncate-collection.adoc @@ -2,8 +2,8 @@ [source,shell] ---- -astra db truncate-collection [-qV] [--no-input] [--[no-]spinner] [--dump-logs - [=FILE]] [-c=COLLECTION] [--color=WHEN] +astra db truncate-collection [-qV] [--no-input] [--[no-]spinner] [--color + [=WHEN]] [--dump-logs[=FILE]] [-c=COLLECTION] [-k=KEYSPACE] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [DB] @@ -38,7 +38,7 @@ Atomically delete all documents in a Data API collection [%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 ==== diff --git a/modules/commands/pages/astra-db-truncate-table.adoc b/modules/commands/pages/astra-db-truncate-table.adoc index c399f4d..a4c110a 100644 --- a/modules/commands/pages/astra-db-truncate-table.adoc +++ b/modules/commands/pages/astra-db-truncate-table.adoc @@ -2,8 +2,8 @@ [source,shell] ---- -astra db truncate-table [-qV] [--no-input] [--[no-]spinner] [--dump-logs - [=FILE]] [--color=WHEN] [-k=KEYSPACE] [-o=FORMAT] +astra db truncate-table [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] + [--dump-logs[=FILE]] [-k=KEYSPACE] [-o=FORMAT] [-t=TABLE] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [DB] @@ -38,7 +38,7 @@ Atomically delete all rows in a table [%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 ==== diff --git a/modules/commands/pages/astra-db.adoc b/modules/commands/pages/astra-db.adoc index 0d69a69..9f4af30 100644 --- a/modules/commands/pages/astra-db.adoc +++ b/modules/commands/pages/astra-db.adoc @@ -2,8 +2,8 @@ [source,shell] ---- -astra db [-qvV] [--no-input] [--[no-]spinner] [--dump-logs[=FILE]] - [--color=WHEN] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN +astra db [-qvV] [--no-input] [--[no-]spinner] [--color[=WHEN]] [--dump-logs + [=FILE]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [COMMAND] ---- @@ -46,10 +46,12 @@ Manage your Astra databases * xref:astra-db-create-region.adoc[astra db create-region] * xref:astra-db-delete-region.adoc[astra db delete-region] * xref:astra-db-list-regions.adoc[astra db list-regions] +* xref:astra-db-list-clouds.adoc[astra db list-clouds] * xref:astra-db-list-regions-classic.adoc[astra db list-regions-classic] * xref:astra-db-list-regions-serverless.adoc[astra db list-regions-serverless] * xref:astra-db-list-regions-vector.adoc[astra db list-regions-vector] -* xref:astra-db-list-clouds.adoc[astra db list-clouds] +* xref:astra-db-regions.adoc[astra db regions] +* xref:astra-db-endpoints.adoc[astra db endpoints] * xref:astra-db-get-endpoint-swagger.adoc[astra db get-endpoint-swagger] * xref:astra-db-get-endpoint-api.adoc[astra db get-endpoint-api] * xref:astra-db-get-endpoint-playground.adoc[astra db get-endpoint-playground] @@ -75,7 +77,7 @@ Manage your Astra databases [%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 ==== diff --git a/modules/commands/pages/astra-nuke.adoc b/modules/commands/pages/astra-nuke.adoc index 07218bc..4768250 100644 --- a/modules/commands/pages/astra-nuke.adoc +++ b/modules/commands/pages/astra-nuke.adoc @@ -3,7 +3,7 @@ [source,shell] ---- astra nuke [-qVy] [--dry-run] [--no-input] [--[no-]preserve-astrarc] [--[no-] - spinner] [--dump-logs[=FILE]] [--color=WHEN] [-o=FORMAT] + spinner] [--color[=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] ---- diff --git a/modules/commands/pages/astra-org-get.adoc b/modules/commands/pages/astra-org-get.adoc index 78bc091..ba606d0 100644 --- a/modules/commands/pages/astra-org-get.adoc +++ b/modules/commands/pages/astra-org-get.adoc @@ -2,9 +2,9 @@ [source,shell] ---- -astra org get [-qV] [--no-input] [--[no-]spinner] [--dump-logs[=FILE]] - [--color=WHEN] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | - [--token=TOKEN [--env=ENV]]] +astra org get [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] [--dump-logs + [=FILE]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN + [--env=ENV]]] ---- @@ -41,7 +41,7 @@ Use the ``--token @file`` syntax to read the token from a file, to avoid potenti [%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 ==== diff --git a/modules/commands/pages/astra-org-id.adoc b/modules/commands/pages/astra-org-id.adoc index 1b1e89f..7bbed22 100644 --- a/modules/commands/pages/astra-org-id.adoc +++ b/modules/commands/pages/astra-org-id.adoc @@ -2,9 +2,9 @@ [source,shell] ---- -astra org id [-qV] [--no-input] [--[no-]spinner] [--dump-logs[=FILE]] - [--color=WHEN] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | - [--token=TOKEN [--env=ENV]]] +astra org id [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] [--dump-logs + [=FILE]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN + [--env=ENV]]] ---- @@ -34,7 +34,7 @@ Get your organization's ID [%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 ==== diff --git a/modules/commands/pages/astra-org-name.adoc b/modules/commands/pages/astra-org-name.adoc index 5b7d6a1..3c8281b 100644 --- a/modules/commands/pages/astra-org-name.adoc +++ b/modules/commands/pages/astra-org-name.adoc @@ -2,9 +2,9 @@ [source,shell] ---- -astra org name [-qV] [--no-input] [--[no-]spinner] [--dump-logs[=FILE]] - [--color=WHEN] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | - [--token=TOKEN [--env=ENV]]] +astra org name [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] [--dump-logs + [=FILE]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN + [--env=ENV]]] ---- @@ -34,7 +34,7 @@ Get your organization's name [%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 ==== diff --git a/modules/commands/pages/astra-org.adoc b/modules/commands/pages/astra-org.adoc index 76eb898..1b6c1eb 100644 --- a/modules/commands/pages/astra-org.adoc +++ b/modules/commands/pages/astra-org.adoc @@ -2,8 +2,8 @@ [source,shell] ---- -astra org [-qV] [--no-input] [--[no-]spinner] [--dump-logs[=FILE]] - [--color=WHEN] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN +astra org [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] [--dump-logs + [=FILE]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [COMMAND] ---- @@ -45,7 +45,7 @@ Use the ``--token @file`` syntax to read the token from a file, to avoid potenti [%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 ==== diff --git a/modules/commands/pages/astra-pcu-associate.adoc b/modules/commands/pages/astra-pcu-associate.adoc index c053ec7..996007f 100644 --- a/modules/commands/pages/astra-pcu-associate.adoc +++ b/modules/commands/pages/astra-pcu-associate.adoc @@ -3,7 +3,7 @@ [source,shell] ---- astra pcu associate [-qV] [--if-not-exists] [--no-input] [--[no-]spinner] - [--dump-logs[=FILE]] [--color=WHEN] [-o=FORMAT] + [--color[=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] GROUP TARGET @@ -38,7 +38,7 @@ Associate a PCU group to a datacenter [%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 ==== diff --git a/modules/commands/pages/astra-pcu-create.adoc b/modules/commands/pages/astra-pcu-create.adoc index 8405938..9fd658f 100644 --- a/modules/commands/pages/astra-pcu-create.adoc +++ b/modules/commands/pages/astra-pcu-create.adoc @@ -2,9 +2,9 @@ [source,shell] ---- -astra pcu create [-qV] [--no-input] [--[no-]spinner] [--dump-logs[=FILE]] - [-c=CLOUD] [--color=WHEN] [-d=DESC] [-it=TYPE] [--max=MAX] - [--min=MIN] [-o=FORMAT] [-pt=TYPE] [-r=REGION] +astra pcu create [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] + [--dump-logs[=FILE]] [-c=CLOUD] [-d=DESC] [-it=TYPE] + [--max=MAX] [--min=MIN] [-o=FORMAT] [-pt=TYPE] [-r=REGION] [--reserved=RESERVED] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [--if-not-exists | --allow-duplicate-names] GROUP @@ -47,7 +47,7 @@ Create a new PCU group [%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 ==== diff --git a/modules/commands/pages/astra-pcu-delete.adoc b/modules/commands/pages/astra-pcu-delete.adoc index 26d2674..507ebc7 100644 --- a/modules/commands/pages/astra-pcu-delete.adoc +++ b/modules/commands/pages/astra-pcu-delete.adoc @@ -3,7 +3,7 @@ [source,shell] ---- astra pcu delete [-qV] [--if-exists] [--no-input] [--[no-]spinner] [--yes] - [--dump-logs[=FILE]] [--color=WHEN] [-o=FORMAT] [[[-cf=PATH] + [--color[=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [GROUP] ---- @@ -37,7 +37,7 @@ Delete an existing Pcu group [%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 ==== diff --git a/modules/commands/pages/astra-pcu-disassociate.adoc b/modules/commands/pages/astra-pcu-disassociate.adoc index ffe963d..ad082bd 100644 --- a/modules/commands/pages/astra-pcu-disassociate.adoc +++ b/modules/commands/pages/astra-pcu-disassociate.adoc @@ -3,7 +3,7 @@ [source,shell] ---- astra pcu disassociate [-qV] [--if-exists] [--no-input] [--[no-]spinner] - [--dump-logs[=FILE]] [--color=WHEN] [-o=FORMAT] + [--color[=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] GROUP TARGET @@ -38,7 +38,7 @@ Disassociate a PCU group to a datacenter [%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 ==== diff --git a/modules/commands/pages/astra-pcu-get.adoc b/modules/commands/pages/astra-pcu-get.adoc index d8ae857..6a2baf7 100644 --- a/modules/commands/pages/astra-pcu-get.adoc +++ b/modules/commands/pages/astra-pcu-get.adoc @@ -2,8 +2,8 @@ [source,shell] ---- -astra pcu get [-qV] [--no-input] [--[no-]spinner] [--dump-logs[=FILE]] - [--color=WHEN] [-k=KEY] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | +astra pcu get [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] [--dump-logs + [=FILE]] [-k=KEY] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [GROUP] ---- @@ -39,7 +39,7 @@ Get information about a specific PCU group. [%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 ==== diff --git a/modules/commands/pages/astra-pcu-list-associations.adoc b/modules/commands/pages/astra-pcu-list-associations.adoc index ba40d76..4a660a3 100644 --- a/modules/commands/pages/astra-pcu-list-associations.adoc +++ b/modules/commands/pages/astra-pcu-list-associations.adoc @@ -2,9 +2,10 @@ [source,shell] ---- -astra pcu list-associations [-aqV] [--no-input] [--[no-]spinner] [--dump-logs - [=FILE]] [--color=WHEN] [-o=FORMAT] [[[-cf=PATH] - [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [GROUP] +astra pcu list-associations [-aqV] [--no-input] [--[no-]spinner] [--color + [=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] + [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN + [--env=ENV]]] [GROUP] ---- @@ -36,7 +37,7 @@ List the associations of a PCU group [%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 ==== diff --git a/modules/commands/pages/astra-pcu-list.adoc b/modules/commands/pages/astra-pcu-list.adoc index 1700845..72aa973 100644 --- a/modules/commands/pages/astra-pcu-list.adoc +++ b/modules/commands/pages/astra-pcu-list.adoc @@ -2,9 +2,9 @@ [source,shell] ---- -astra pcu list [-qV] [--no-input] [--[no-]spinner] [--dump-logs[=FILE]] - [--color=WHEN] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | - [--token=TOKEN [--env=ENV]]] +astra pcu list [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] [--dump-logs + [=FILE]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN + [--env=ENV]]] ---- @@ -37,7 +37,7 @@ List your PCU groups [%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 ==== diff --git a/modules/commands/pages/astra-pcu-park.adoc b/modules/commands/pages/astra-pcu-park.adoc index 27cf2d4..b97f508 100644 --- a/modules/commands/pages/astra-pcu-park.adoc +++ b/modules/commands/pages/astra-pcu-park.adoc @@ -2,8 +2,8 @@ [source,shell] ---- -astra pcu park [-qV] [--[no-]async] [--no-input] [--[no-]spinner] [--dump-logs - [=FILE]] [--color=WHEN] [-o=FORMAT] [--timeout=] +astra pcu park [-qV] [--[no-]async] [--no-input] [--[no-]spinner] [--color + [=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] [--timeout=] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [GROUP] ---- @@ -37,7 +37,7 @@ Park an existing PCU group [%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 ==== diff --git a/modules/commands/pages/astra-pcu-status.adoc b/modules/commands/pages/astra-pcu-status.adoc index 0086049..4c6c896 100644 --- a/modules/commands/pages/astra-pcu-status.adoc +++ b/modules/commands/pages/astra-pcu-status.adoc @@ -2,8 +2,8 @@ [source,shell] ---- -astra pcu status [-qV] [--no-input] [--[no-]spinner] [--dump-logs[=FILE]] - [--color=WHEN] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | +astra pcu status [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] + [--dump-logs[=FILE]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [GROUP] ---- @@ -35,7 +35,7 @@ Get the current status of a PCU group. [%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 ==== diff --git a/modules/commands/pages/astra-pcu-transfer-association.adoc b/modules/commands/pages/astra-pcu-transfer-association.adoc index 1a508fb..8750bc9 100644 --- a/modules/commands/pages/astra-pcu-transfer-association.adoc +++ b/modules/commands/pages/astra-pcu-transfer-association.adoc @@ -3,7 +3,7 @@ [source,shell] ---- astra pcu transfer-association [-qV] [--if-not-exists] [--no-input] [--[no-] - spinner] [--dump-logs[=FILE]] [--color=WHEN] + spinner] [--color[=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] -t=GROUP [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [-f=GROUP | --or-create] TARGET @@ -41,7 +41,7 @@ Transfer an association from one PCU group to another [%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 ==== diff --git a/modules/commands/pages/astra-pcu-unpark.adoc b/modules/commands/pages/astra-pcu-unpark.adoc index 7c41697..70e2416 100644 --- a/modules/commands/pages/astra-pcu-unpark.adoc +++ b/modules/commands/pages/astra-pcu-unpark.adoc @@ -2,9 +2,10 @@ [source,shell] ---- -astra pcu unpark [-qV] [--[no-]async] [--no-input] [--[no-]spinner] [--dump-logs - [=FILE]] [--color=WHEN] [-o=FORMAT] [--timeout=] - [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [GROUP] +astra pcu unpark [-qV] [--[no-]async] [--no-input] [--[no-]spinner] [--color + [=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] + [--timeout=] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN + [--env=ENV]]] [GROUP] ---- @@ -37,7 +38,7 @@ Unpark a parked PCU group [%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 ==== diff --git a/modules/commands/pages/astra-pcu-update.adoc b/modules/commands/pages/astra-pcu-update.adoc index 832062e..166fbfe 100644 --- a/modules/commands/pages/astra-pcu-update.adoc +++ b/modules/commands/pages/astra-pcu-update.adoc @@ -3,7 +3,7 @@ [source,shell] ---- astra pcu update [-qV] [--allow-duplicate-names] [--no-input] [--[no-]spinner] - [--dump-logs[=FILE]] [-c=CLOUD] [--color=WHEN] [-d=DESC] + [--color[=WHEN]] [--dump-logs[=FILE]] [-c=CLOUD] [-d=DESC] [-it=TYPE] [--max=MAX] [--min=MIN] [-o=FORMAT] [-pt=TYPE] [-r=REGION] [--reserved=RESERVED] [-t=TITLE] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [GROUP] @@ -47,7 +47,7 @@ Update an existing PCU group [%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 ==== diff --git a/modules/commands/pages/astra-pcu.adoc b/modules/commands/pages/astra-pcu.adoc index edcd9ca..7c93f72 100644 --- a/modules/commands/pages/astra-pcu.adoc +++ b/modules/commands/pages/astra-pcu.adoc @@ -2,8 +2,8 @@ [source,shell] ---- -astra pcu [-qV] [--no-input] [--[no-]spinner] [--dump-logs[=FILE]] - [--color=WHEN] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN +astra pcu [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] [--dump-logs + [=FILE]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [COMMAND] ---- @@ -50,7 +50,7 @@ Manage your PCU groups and associations [%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 ==== diff --git a/modules/commands/pages/astra-role-get.adoc b/modules/commands/pages/astra-role-get.adoc index 28ddbca..e798ce1 100644 --- a/modules/commands/pages/astra-role-get.adoc +++ b/modules/commands/pages/astra-role-get.adoc @@ -2,9 +2,9 @@ [source,shell] ---- -astra role get [-qV] [--no-input] [--[no-]spinner] [--dump-logs[=FILE]] - [--color=WHEN] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | - [--token=TOKEN [--env=ENV]]] ROLE +astra role get [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] [--dump-logs + [=FILE]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN + [--env=ENV]]] ROLE ---- @@ -38,7 +38,7 @@ Show details for a specific role [%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 ==== diff --git a/modules/commands/pages/astra-role-list.adoc b/modules/commands/pages/astra-role-list.adoc index f7253f4..4c22031 100644 --- a/modules/commands/pages/astra-role-list.adoc +++ b/modules/commands/pages/astra-role-list.adoc @@ -2,8 +2,8 @@ [source,shell] ---- -astra role list [-qV] [--no-input] [--[no-]spinner] [--dump-logs[=FILE]] - [--color=WHEN] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | +astra role list [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] + [--dump-logs[=FILE]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] ---- @@ -34,7 +34,7 @@ Display all roles [%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 ==== diff --git a/modules/commands/pages/astra-setup.adoc b/modules/commands/pages/astra-setup.adoc index 21a87b5..264b87d 100644 --- a/modules/commands/pages/astra-setup.adoc +++ b/modules/commands/pages/astra-setup.adoc @@ -2,8 +2,8 @@ [source,shell] ---- -astra setup [-qV] [--no-input] [--[no-]spinner] [--dump-logs[=FILE]] - [--color=WHEN] [-e=ENV] [--name=NAME] [-o=FORMAT] [-t=TOKEN] +astra setup [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] [--dump-logs + [=FILE]] [-e=ENV] [--name=NAME] [-o=FORMAT] [-t=TOKEN] ---- diff --git a/modules/commands/pages/astra-streaming-create.adoc b/modules/commands/pages/astra-streaming-create.adoc index d4b0fff..8ea57b1 100644 --- a/modules/commands/pages/astra-streaming-create.adoc +++ b/modules/commands/pages/astra-streaming-create.adoc @@ -3,10 +3,10 @@ [source,shell] ---- astra streaming create [-qV] [--if-not-exists] [--no-input] [--[no-]spinner] - [--dump-logs[=FILE]] [--color=WHEN] [-o=FORMAT] - [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] - ([--plan=PLAN] | -e=EMAIL | (--cluster=CLUSTER | - [-r=REGION [-c=CLOUD]])) TENANT + [--color[=WHEN]] [--dump-logs[=FILE]] [-c=CLOUD] + --cluster=CLUSTER [-e=EMAIL] [-o=FORMAT] [--plan=PLAN] + -r=REGION [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN + [--env=ENV]]] TENANT ---- @@ -43,7 +43,7 @@ Create a new streaming 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 ==== diff --git a/modules/commands/pages/astra-streaming-delete.adoc b/modules/commands/pages/astra-streaming-delete.adoc index 3b3186c..d69a996 100644 --- a/modules/commands/pages/astra-streaming-delete.adoc +++ b/modules/commands/pages/astra-streaming-delete.adoc @@ -3,7 +3,7 @@ [source,shell] ---- astra streaming delete [-qV] [--if-exists] [--no-input] [--[no-]spinner] - [--dump-logs[=FILE]] [--color=WHEN] [-o=FORMAT] + [--color[=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [TENANT] @@ -37,7 +37,7 @@ Delete an existing streaming 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 ==== diff --git a/modules/commands/pages/astra-streaming-exist.adoc b/modules/commands/pages/astra-streaming-exist.adoc index 6c47aa0..072799c 100644 --- a/modules/commands/pages/astra-streaming-exist.adoc +++ b/modules/commands/pages/astra-streaming-exist.adoc @@ -2,9 +2,9 @@ [source,shell] ---- -astra streaming exist [-qV] [--no-input] [--[no-]spinner] [--dump-logs[=FILE]] - [--color=WHEN] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | - [--token=TOKEN [--env=ENV]]] TENANT +astra streaming exist [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] + [--dump-logs[=FILE]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] + | [--token=TOKEN [--env=ENV]]] TENANT ---- @@ -35,7 +35,7 @@ Show existence of a streaming 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 ==== diff --git a/modules/commands/pages/astra-streaming-get.adoc b/modules/commands/pages/astra-streaming-get.adoc index d40ca21..f2481b2 100644 --- a/modules/commands/pages/astra-streaming-get.adoc +++ b/modules/commands/pages/astra-streaming-get.adoc @@ -2,9 +2,9 @@ [source,shell] ---- -astra streaming get [-qV] [--no-input] [--[no-]spinner] [--dump-logs[=FILE]] - [--color=WHEN] [-k=KEY] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] - | [--token=TOKEN [--env=ENV]]] [TENANT] +astra streaming get [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] + [--dump-logs[=FILE]] [-k=KEY] [-o=FORMAT] [[[-cf=PATH] + [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [TENANT] ---- @@ -39,7 +39,7 @@ Get the info about a streaming 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 ==== diff --git a/modules/commands/pages/astra-streaming-list-clouds.adoc b/modules/commands/pages/astra-streaming-list-clouds.adoc index 2cb66b4..70b21f8 100644 --- a/modules/commands/pages/astra-streaming-list-clouds.adoc +++ b/modules/commands/pages/astra-streaming-list-clouds.adoc @@ -2,9 +2,10 @@ [source,shell] ---- -astra streaming list-clouds [-qV] [--no-input] [--[no-]spinner] [--dump-logs - [=FILE]] [--color=WHEN] [-o=FORMAT] [[[-cf=PATH] - [-p=NAME]] | [--token=TOKEN [--env=ENV]]] +astra streaming list-clouds [-qV] [--no-input] [--[no-]spinner] [--color + [=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] + [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN + [--env=ENV]]] ---- @@ -34,7 +35,7 @@ List all available cloud providers for Astra streaming tenants [%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 ==== diff --git a/modules/commands/pages/astra-streaming-list-regions.adoc b/modules/commands/pages/astra-streaming-list-regions.adoc index cacf925..03ba304 100644 --- a/modules/commands/pages/astra-streaming-list-regions.adoc +++ b/modules/commands/pages/astra-streaming-list-regions.adoc @@ -2,11 +2,11 @@ [source,shell] ---- -astra streaming list-regions [-qV] [--no-input] [--[no-]spinner] [--dump-logs - [=FILE]] [--color=WHEN] [-o=FORMAT] [-c=FILTER[, - FILTER...]]... [-f=FILTER[,FILTER...]]... - [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN - [--env=ENV]]] +astra streaming list-regions [-qV] [--no-input] [--[no-]spinner] [--color + [=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] + [-c=FILTER[,FILTER...]]... [-f=FILTER[, + FILTER...]]... [[[-cf=PATH] [-p=NAME]] | + [--token=TOKEN [--env=ENV]]] ---- @@ -38,7 +38,7 @@ List all available regions for Astra streaming tenants [%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 ==== diff --git a/modules/commands/pages/astra-streaming-list.adoc b/modules/commands/pages/astra-streaming-list.adoc index 5424023..d2019e9 100644 --- a/modules/commands/pages/astra-streaming-list.adoc +++ b/modules/commands/pages/astra-streaming-list.adoc @@ -2,8 +2,8 @@ [source,shell] ---- -astra streaming list [-qV] [--no-input] [--[no-]spinner] [--dump-logs[=FILE]] - [--color=WHEN] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | +astra streaming list [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] + [--dump-logs[=FILE]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] ---- @@ -37,7 +37,7 @@ List your Astra streaming tenants [%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 ==== diff --git a/modules/commands/pages/astra-streaming-pulsar-path.adoc b/modules/commands/pages/astra-streaming-pulsar-path.adoc index 2b3d89d..a9b6ce4 100644 --- a/modules/commands/pages/astra-streaming-pulsar-path.adoc +++ b/modules/commands/pages/astra-streaming-pulsar-path.adoc @@ -3,7 +3,7 @@ [source,shell] ---- astra streaming pulsar path [-qV] [--if-exists] [--no-input] [--[no-]spinner] - [--dump-logs[=FILE]] [--color=WHEN] [-o=FORMAT] + [--color[=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] @@ -36,7 +36,7 @@ Get the path to the currently installed pulsar 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 ==== diff --git a/modules/commands/pages/astra-streaming-pulsar-shell.adoc b/modules/commands/pages/astra-streaming-pulsar-shell.adoc index 055d5fd..bd13de2 100644 --- a/modules/commands/pages/astra-streaming-pulsar-shell.adoc +++ b/modules/commands/pages/astra-streaming-pulsar-shell.adoc @@ -2,8 +2,8 @@ [source,shell] ---- -astra streaming pulsar shell [-FqV] [--no-input] [-np] [--[no-]spinner] - [--dump-logs[=FILE]] [--color=WHEN] [-o=FORMAT] +astra streaming pulsar shell [-FqV] [--no-input] [-np] [--[no-]spinner] [--color + [=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [-e=STATEMENT | -f=FILE] [TENANT] @@ -40,7 +40,7 @@ Launch Apache Pulsar shell for a streaming 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 ==== diff --git a/modules/commands/pages/astra-streaming-pulsar-token.adoc b/modules/commands/pages/astra-streaming-pulsar-token.adoc index 5da741b..2ff85f0 100644 --- a/modules/commands/pages/astra-streaming-pulsar-token.adoc +++ b/modules/commands/pages/astra-streaming-pulsar-token.adoc @@ -2,9 +2,10 @@ [source,shell] ---- -astra streaming pulsar-token [-qV] [--no-input] [--[no-]spinner] [--dump-logs - [=FILE]] [--color=WHEN] [-o=FORMAT] [[[-cf=PATH] - [-p=NAME]] | [--token=TOKEN [--env=ENV]]] TENANT +astra streaming pulsar-token [-qV] [--no-input] [--[no-]spinner] [--color + [=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] + [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN + [--env=ENV]]] TENANT ---- @@ -35,7 +36,7 @@ Get the Pulsar token for a streaming 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 ==== diff --git a/modules/commands/pages/astra-streaming-pulsar-version.adoc b/modules/commands/pages/astra-streaming-pulsar-version.adoc index 63050e6..79d0439 100644 --- a/modules/commands/pages/astra-streaming-pulsar-version.adoc +++ b/modules/commands/pages/astra-streaming-pulsar-version.adoc @@ -2,9 +2,10 @@ [source,shell] ---- -astra streaming pulsar version [-qV] [--no-input] [--[no-]spinner] [--dump-logs - [=FILE]] [--color=WHEN] [-o=FORMAT] [[[-cf=PATH] - [-p=NAME]] | [--token=TOKEN [--env=ENV]]] +astra streaming pulsar version [-qV] [--no-input] [--[no-]spinner] [--color + [=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] + [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN + [--env=ENV]]] ---- @@ -34,7 +35,7 @@ Display the currently installed pulsar'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 ==== diff --git a/modules/commands/pages/astra-streaming-status.adoc b/modules/commands/pages/astra-streaming-status.adoc index 4d60cec..c8afaab 100644 --- a/modules/commands/pages/astra-streaming-status.adoc +++ b/modules/commands/pages/astra-streaming-status.adoc @@ -2,9 +2,9 @@ [source,shell] ---- -astra streaming status [-qV] [--no-input] [--[no-]spinner] [--dump-logs[=FILE]] - [--color=WHEN] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | - [--token=TOKEN [--env=ENV]]] [TENANT] +astra streaming status [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] + [--dump-logs[=FILE]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] + | [--token=TOKEN [--env=ENV]]] [TENANT] ---- @@ -35,7 +35,7 @@ Get the current status of a streaming 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 ==== diff --git a/modules/commands/pages/astra-streaming.adoc b/modules/commands/pages/astra-streaming.adoc index dc38dd8..4921536 100644 --- a/modules/commands/pages/astra-streaming.adoc +++ b/modules/commands/pages/astra-streaming.adoc @@ -2,8 +2,8 @@ [source,shell] ---- -astra streaming [-qV] [--no-input] [--[no-]spinner] [--dump-logs[=FILE]] - [--color=WHEN] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | +astra streaming [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] + [--dump-logs[=FILE]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [COMMAND] ---- @@ -48,7 +48,7 @@ Manage Astra streaming tenants [%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 ==== diff --git a/modules/commands/pages/astra-token-create.adoc b/modules/commands/pages/astra-token-create.adoc index bc6bec3..ad4dd9e 100644 --- a/modules/commands/pages/astra-token-create.adoc +++ b/modules/commands/pages/astra-token-create.adoc @@ -2,9 +2,9 @@ [source,shell] ---- -astra token create [-qV] [--no-input] [--[no-]spinner] [--dump-logs[=FILE]] - [--color=WHEN] [-d=DESC] [-o=FORMAT] -r=ROLE [[[-cf=PATH] - [-p=NAME]] | [--token=TOKEN [--env=ENV]]] +astra token create [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] + [--dump-logs[=FILE]] [-d=DESC] [-o=FORMAT] -r=ROLE + [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] ---- @@ -36,7 +36,7 @@ Create a new token [%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 ==== diff --git a/modules/commands/pages/astra-token-delete.adoc b/modules/commands/pages/astra-token-delete.adoc index e324b03..12f6b9a 100644 --- a/modules/commands/pages/astra-token-delete.adoc +++ b/modules/commands/pages/astra-token-delete.adoc @@ -2,8 +2,8 @@ [source,shell] ---- -astra token delete [-qV] [--if-exists] [--no-input] [--[no-]spinner] - [--dump-logs[=FILE]] [--color=WHEN] [-o=FORMAT] [[[-cf=PATH] +astra token delete [-qV] [--if-exists] [--no-input] [--[no-]spinner] [--color + [=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] TOKEN ---- @@ -39,7 +39,7 @@ Delete a token [%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 ==== diff --git a/modules/commands/pages/astra-token-get.adoc b/modules/commands/pages/astra-token-get.adoc index 7fba8f3..4b4a7fe 100644 --- a/modules/commands/pages/astra-token-get.adoc +++ b/modules/commands/pages/astra-token-get.adoc @@ -2,9 +2,9 @@ [source,shell] ---- -astra token get [-cqV] [--no-input] [--[no-]spinner] [--validate] [--dump-logs - [=FILE]] [--color=WHEN] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | - [--token=TOKEN [--env=ENV]]] +astra token get [-cqV] [--no-input] [--[no-]spinner] [--validate] [--color + [=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] [[[-cf=PATH] + [-p=NAME]] | [--token=TOKEN [--env=ENV]]] ---- @@ -39,7 +39,7 @@ Show your current token [%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 ==== diff --git a/modules/commands/pages/astra-token-list.adoc b/modules/commands/pages/astra-token-list.adoc index 0290f81..8ef0b71 100644 --- a/modules/commands/pages/astra-token-list.adoc +++ b/modules/commands/pages/astra-token-list.adoc @@ -2,8 +2,8 @@ [source,shell] ---- -astra token list [-qV] [--no-input] [--[no-]spinner] [--dump-logs[=FILE]] - [--color=WHEN] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | +astra token list [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] + [--dump-logs[=FILE]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] ---- @@ -34,7 +34,7 @@ List your tokens' information [%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 ==== diff --git a/modules/commands/pages/astra-token.adoc b/modules/commands/pages/astra-token.adoc index 1fb379f..b675100 100644 --- a/modules/commands/pages/astra-token.adoc +++ b/modules/commands/pages/astra-token.adoc @@ -2,8 +2,8 @@ [source,shell] ---- -astra token [-cqV] [--no-input] [--[no-]spinner] [--validate] [--dump-logs - [=FILE]] [--color=WHEN] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | +astra token [-cqV] [--no-input] [--[no-]spinner] [--validate] [--color[=WHEN]] + [--dump-logs[=FILE]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] [COMMAND] ---- @@ -44,7 +44,7 @@ Manage your Astra tokens [%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 ==== diff --git a/modules/commands/pages/astra-upgrade.adoc b/modules/commands/pages/astra-upgrade.adoc index a7019f2..fb861e7 100644 --- a/modules/commands/pages/astra-upgrade.adoc +++ b/modules/commands/pages/astra-upgrade.adoc @@ -2,8 +2,8 @@ [source,shell] ---- -astra upgrade [-qV] [--allow-reinstall] [--no-input] [--[no-]spinner] - [--dump-logs[=FILE]] [--color=WHEN] [-o=FORMAT] [-v=TAG | --pre] +astra upgrade [-qV] [--allow-reinstall] [--no-input] [--[no-]spinner] [--color + [=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] [-v=TAG | --pre] ---- diff --git a/modules/commands/pages/astra-user-delete.adoc b/modules/commands/pages/astra-user-delete.adoc index 77c063f..cb7043d 100644 --- a/modules/commands/pages/astra-user-delete.adoc +++ b/modules/commands/pages/astra-user-delete.adoc @@ -2,9 +2,9 @@ [source,shell] ---- -astra user delete [-qV] [--if-exists] [--no-input] [--[no-]spinner] [--dump-logs - [=FILE]] [--color=WHEN] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | - [--token=TOKEN [--env=ENV]]] USER +astra user delete [-qV] [--if-exists] [--no-input] [--[no-]spinner] [--color + [=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] [[[-cf=PATH] + [-p=NAME]] | [--token=TOKEN [--env=ENV]]] USER ---- @@ -36,7 +36,7 @@ Delete an existing user [%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 ==== diff --git a/modules/commands/pages/astra-user-get.adoc b/modules/commands/pages/astra-user-get.adoc index da752f7..d9547a7 100644 --- a/modules/commands/pages/astra-user-get.adoc +++ b/modules/commands/pages/astra-user-get.adoc @@ -2,9 +2,9 @@ [source,shell] ---- -astra user get [-qV] [--no-input] [--[no-]spinner] [--dump-logs[=FILE]] - [--color=WHEN] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | - [--token=TOKEN [--env=ENV]]] USER +astra user get [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] [--dump-logs + [=FILE]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN + [--env=ENV]]] USER ---- @@ -38,7 +38,7 @@ Show details for a specific user [%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 ==== diff --git a/modules/commands/pages/astra-user-invite.adoc b/modules/commands/pages/astra-user-invite.adoc index ff64f6f..b119fcc 100644 --- a/modules/commands/pages/astra-user-invite.adoc +++ b/modules/commands/pages/astra-user-invite.adoc @@ -2,8 +2,8 @@ [source,shell] ---- -astra user invite [-qV] [--if-not-exists] [--no-input] [--[no-]spinner] - [--dump-logs[=FILE]] [--color=WHEN] [-o=FORMAT] [-r=<$roles>[, +astra user invite [-qV] [--if-not-exists] [--no-input] [--[no-]spinner] [--color + [=WHEN]] [--dump-logs[=FILE]] [-o=FORMAT] [-r=<$roles>[, <$roles>...]]... [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] USER @@ -38,7 +38,7 @@ Invite a user to an organization [%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 ==== diff --git a/modules/commands/pages/astra-user-list.adoc b/modules/commands/pages/astra-user-list.adoc index d3515ef..0b2111b 100644 --- a/modules/commands/pages/astra-user-list.adoc +++ b/modules/commands/pages/astra-user-list.adoc @@ -2,8 +2,8 @@ [source,shell] ---- -astra user list [-qV] [--no-input] [--[no-]spinner] [--dump-logs[=FILE]] - [--color=WHEN] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | +astra user list [-qV] [--no-input] [--[no-]spinner] [--color[=WHEN]] + [--dump-logs[=FILE]] [-o=FORMAT] [[[-cf=PATH] [-p=NAME]] | [--token=TOKEN [--env=ENV]]] ---- @@ -34,7 +34,7 @@ List all users in the org [%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 ====