diff --git a/docs-src/astra-cli-core/antora.yml b/docs-src/astra-cli-core/antora.yml index 7e50f45..19c1906 100644 --- a/docs-src/astra-cli-core/antora.yml +++ b/docs-src/astra-cli-core/antora.yml @@ -8,19 +8,26 @@ nav: asciidoc: attributes: + # General attributes + company: 'DataStax' + support-url: 'https://support.datastax.com' + # Other product attributes + cass-reg: 'Apache Cassandra(R)' + cass: 'Apache Cassandra' + cass-short: 'Cassandra' + # Astra DB attributes + astra-db: 'Astra DB' product: 'Astra CLI' + product-short: 'Astra' product-version: '0.6' - astra: 'Astra' db-serverless: 'Serverless (Non-Vector)' db-serverless-vector: 'Serverless (Vector)' db-classic: 'Classic' - astra-api: 'Data API' - url-astra: 'https://astra.datastax.com' - link-astra-portal: '{url-astra}[{astra_ui}^]' - py-client-api-ref-url: 'xref:astra-api-docs:ROOT:attachment$python-client/astrapy' - ts-client-api-ref-url: 'xref:astra-api-docs:ROOT:attachment$typescript-client' - java-client-api-ref-url: 'xref:astra-api-docs:ROOT:attachment$java-client' - cass-short: 'Cassandra' - scb-long: Secure Connect Bundle (SCB) - scb-cap: Secure Connect Bundle - scb: SCB + devops-api: 'DevOps API' + astra-stream: 'Astra Streaming' + astra-ui: 'Astra Portal' + astra-url: 'https://astra.datastax.com' + astra-ui-link: '{astra-url}[{astra-ui}^]' + scb: 'Secure Connect Bundle (SCB)' + scb-short: 'SCB' + scb-brief: 'Secure Connect Bundle' diff --git a/docs-src/astra-cli-core/modules/ROOT/pages/administration.adoc b/docs-src/astra-cli-core/modules/ROOT/pages/administration.adoc index 492c7b3..aba8197 100644 --- a/docs-src/astra-cli-core/modules/ROOT/pages/administration.adoc +++ b/docs-src/astra-cli-core/modules/ROOT/pages/administration.adoc @@ -1,11 +1,11 @@ -= Manage your Astra organization with the {product} -:navtitle: Manage Astra administration += Manage your {product-short} organization with the {product} +:navtitle: Manage {product-short} administration -Use the {product} to manage your Astra organization. +Use the {product} to manage your {product-short} organization. == Get organization details -Use the `astra org` command to get information about the current Astra organization: +Use the `astra org` command to get information about the current {product-short} organization: [source,bash] ---- @@ -49,7 +49,7 @@ SYNOPSIS == List users -Use the `astra user list` command to list all users in your Astra organization: +Use the `astra user list` command to list all users in your {product-short} organization: [source,bash] ---- @@ -113,7 +113,7 @@ OPTIONS == Add a user -Use the `astra user invite` command to invite a new user to your Astra organization: +Use the `astra user invite` command to invite a new user to your {product-short} organization: [source,bash,subs="+quotes"] ---- @@ -218,7 +218,7 @@ astra user invite alice@example.com -r "Organization Administrator" == Get user details -Use the `astra user get` or `astra user describe` command to get information about a specific user in your Astra organization: +Use the `astra user get` or `astra user describe` command to get information about a specific user in your {product-short} organization: [source,bash,subs="+quotes"] ---- @@ -358,7 +358,7 @@ The user can still access their personal {astra_db} account, if they have access If your organization uses SSO, make sure that you also remove the user from your IdP, if necessary. ==== -Use the `astra user delete` command to remove a user or revoke their invitation from your Astra organization: +Use the `astra user delete` command to remove a user or revoke their invitation from your {product-short} organization: [source,bash,subs="+quotes"] ---- @@ -427,7 +427,7 @@ OPTIONS [#list-roles] == List roles -Use the `astra role list` command to list all xref:astra-db-serverless:administration:manage-database-access.adoc#default-roles[default roles] and xref:astra-db-serverless:administration:manage-database-access.adoc#custom-roles[custom roles] in your Astra organization: +Use the `astra role list` command to list all xref:astra-db-serverless:administration:manage-database-access.adoc#default-roles[default roles] and xref:astra-db-serverless:administration:manage-database-access.adoc#custom-roles[custom roles] in your {product-short} organization: [source,bash] ---- @@ -505,7 +505,7 @@ OPTIONS == Get role details -Use the `astra role get` or `astra role describe` command to get information about a specific role in your Astra organization: +Use the `astra role get` or `astra role describe` command to get information about a specific role in your {product-short} organization: [source,bash,subs="+quotes"] ---- @@ -680,7 +680,7 @@ OPTIONS [#list-tokens] == Get a list of tokens -Use the `astra token list` command to list all of the application tokens in your Astra organization: +Use the `astra token list` command to list all of the application tokens in your {product-short} organization: [source,bash] ---- @@ -741,7 +741,7 @@ OPTIONS == Create an application token -Use the `astra token create` command to create a new application token in your Astra organization: +Use the `astra token create` command to create a new application token in your {product-short} organization: [source,bash,subs="+quotes"] ---- @@ -875,7 +875,7 @@ OPTIONS Application tokens never expire. ==== -Use the `astra token delete` or `astra token revoke` command to delete an application token from your Astra organization: +Use the `astra token delete` or `astra token revoke` command to delete an application token from your {product-short} organization: [source,bash,subs="+quotes"] ---- diff --git a/docs-src/astra-cli-core/modules/ROOT/pages/astra-streaming-cli.adoc b/docs-src/astra-cli-core/modules/ROOT/pages/astra-streaming-cli.adoc index e4d488a..7a354be 100644 --- a/docs-src/astra-cli-core/modules/ROOT/pages/astra-streaming-cli.adoc +++ b/docs-src/astra-cli-core/modules/ROOT/pages/astra-streaming-cli.adoc @@ -24,8 +24,10 @@ https://api.astra.datastax.com/v2/streaming/tenants/my-streaming-tenant Running `astra streaming create` without any options deploys the tenant in the default cloud provider (`aws`), region (`useast2`), plan (`free`) and namespace (`default`). -[NOTE] -====== +[TIP] +==== +Tenant names must be unique + All tenant names in {astra_stream} must be unique. If the tenant name is already in use, the command fails with with the following error message: @@ -40,6 +42,7 @@ You can use the `--if-not-exist` option to only create the tenant if it doesn't ---- astra streaming create **TENANT_NAME** --if-not-exist ---- +==== .Result [%collapsible] @@ -67,7 +70,6 @@ https://api.astra.datastax.com/v2/streaming/tenants/my-streaming-tenant [OK] Tenant 'my-streaming-tenant' exists. ---- ==== -====== === `streaming create` options @@ -541,7 +543,7 @@ OPTIONS == Get a list of available {astra_stream} regions -Use the `astra streaming list-regions` command to get a list of available cloud provider regions that support {astra_stream}: +Use the `astra streaming list-regions` command to get a list of available regions that support {astra_stream}: [source,bash] ---- @@ -550,34 +552,19 @@ astra streaming list-regions .Result [%collapsible] -====== -[source,console] +==== +The result is a table with `Cloud Provider`, `Region`, and `Full Name` columns. +`Full Name` can be empty or contain the region's name and location (city, state, or country). + +[source,console,subs="+quotes"] ---- +-----------------+---------------------+-------------------------------+ | Cloud Provider | Region | Full Name | +-----------------+---------------------+-------------------------------+ -| aws | apsouth1 | | -| aws | apsoutheast1 | | -| aws | apsoutheast2 | | -| aws | eucentral1 | | -| aws | euwest1 | | -| aws | useast1 | | -| aws | useast2 | | -| aws | uswest2 | | -| azure | australiaeast | | -| azure | eastus | | -| azure | westeurope | | -| azure | westus2 | | -| gcp | australiase1 | | -| gcp | europewest1 | | -| gcp | uscentral1 | | -| gcp | useast1 | | -| gcp | useast4 | | +| **PROVIDER** | **REGION** | **NAME** | +-----------------+---------------------+-------------------------------+ ---- - -include::ROOT:partial$regions-change-admonition.adoc[] -====== +==== === `streaming list-regions` options @@ -1080,13 +1067,16 @@ ASTRA_STREAMING_WEBSOCKET_URL="wss://pulsar-aws-useast2.streaming.datastax.com:8 [WARNING] ==== -The generated `.env` files contains sensitive information, including the application token that the {product} uses to connect to Astra. +The generated `.env` files contains sensitive information, including the application token that the {product} uses to connect to {product-short}. The {scb} contains sensitive information that establishes a connection to your database, including key pairs and certificates. ==== === `streaming create-dotenv` options +The directory must already exist before you run the `streaming create-dotenv` command. +If the directory doesn't exist, the command fails with the error `INVALID_ARGUMENT: Destination folder has not been found`. + .Expand to see all `streaming create-dotenv` options [%collapsible] ==== @@ -1152,10 +1142,4 @@ astra streaming create-dotenv **TENANT_NAME** -d ~/tmp ---- [OK] File '/Users/USERNAME/tmp/.env' has been created/amended ---- -==== - -[NOTE] -==== -The directory must already exist before you run the command. -If the directory doesn't exist, the {product} will report the following error: `INVALID_ARGUMENT: Destination folder has not been found`. -==== +==== \ No newline at end of file diff --git a/docs-src/astra-cli-core/modules/ROOT/pages/getting-started.adoc b/docs-src/astra-cli-core/modules/ROOT/pages/getting-started.adoc index 7bd7fa6..ffb35c7 100644 --- a/docs-src/astra-cli-core/modules/ROOT/pages/getting-started.adoc +++ b/docs-src/astra-cli-core/modules/ROOT/pages/getting-started.adoc @@ -1,7 +1,5 @@ = Get started with the {product} :navtitle: Get started -// include::astra-db-serverless:ROOT:partial$astra-role-attributes.adoc[] -// include::astra-db-serverless:ROOT:partial$astra-permission-attributes.adoc[] Initialize the {product} and run your first commands. @@ -11,20 +9,20 @@ To configure the {product}: * xref:ROOT:installation.adoc[Install the {product}]. -* You must have an active {url-astra}[Astra account^]. +* You must have an active {astra-url}[{product-short} account^]. * [[get-credentials]]You must have an xref:astra-db-serverless:administration:manage-application-tokens.adoc[application token] that is assigned a _role_ with adequate _permissions_ to perform the tasks you'd like to accomplish with the {product}. -** *Non-production organizations*: If your Astra organization has no databases or streaming tenants that handle sensitive information, you can grant your application token the `Organization Administrator` role to try out all of the {product} features. +** *Non-production organizations*: If your {product-short} organization has no databases or streaming tenants that handle sensitive information, you can grant your application token the `Organization Administrator` role to try out all of the {product} features. -** *Production organizations*: If you're using Astra in production, {company} recommends that you use a xref:astra-db-serverless:administration:manage-database-access.adoc#custom-roles[custom role] to grant your application token the bare minimum xref:astra-db-serverless:administration:manage-database-access.adoc#about-permissions[permissions] required to perform the required tasks with the {product}. +** *Production organizations*: If you're using {product-short} in production, {company} recommends that you use a xref:astra-db-serverless:administration:manage-database-access.adoc#custom-roles[custom role] to grant your application token the bare minimum xref:astra-db-serverless:administration:manage-database-access.adoc#about-permissions[permissions] required to perform the required tasks with the {product}. * If you plan to manage an {astra_db} database that has restricted public access, then you must xref:astra-db-serverless:administration:manage-database-ip-access-list.adoc#add-ip-access-list-entries[add your IP address to the database's access list]. [#initialize] == Initialize the {product} -After installation, initialize the {product} and connect it to an existing Astra account. +After installation, initialize the {product} and connect it to an existing {product-short} account. . Use the `astra setup` command to initialize the {product} with your xref:astra-db-serverless:administration:manage-application-tokens.adoc[application token]: + @@ -77,9 +75,9 @@ Application tokens are stored in plain text in the `~/.astrarc` file. Your application tokens are like passwords, therefore you should take precautions to secure the configuration file. ==== -== Display help information +== Print help information -Use `astra help` to display the main help information: +Use `astra help` to print general {product} help information: [source,bash] ---- @@ -87,7 +85,7 @@ astra help ---- .Result -[%collapsible%open] +[%collapsible] ==== [source,console] ---- @@ -110,7 +108,7 @@ See 'astra help ' for more information on a specific command. ---- ==== -Append a command name to display help information about an individual command. +Append a command name to print help information about an individual command. For example: [source,bash] @@ -237,6 +235,8 @@ SYNOPSIS ---- ==== +Append a subcommand for further specificity: + [source,bash] ---- astra help db list @@ -307,15 +307,18 @@ astra kbd:[Tab] kbd:[Tab] == Manage the {product} configuration When you run the `astra setup` command during <>, the {product} stores your application token as the default configuration in the `~/.astrarc` configuration file. + You can create additional configurations, each with their own application token, to make it easier to manage different types of resources across one or more organizations. -Use `astra config list` to list all current configurations: +=== Get and set configurations +. Use `astra config list` to list all current configurations: ++ [source,bash] ---- astra config list ---- - ++ .Result [%collapsible] ==== @@ -328,13 +331,13 @@ astra config list +----------------------------+ ==== -Use `astra config create` to create a new configuration: - +. Use `astra config create` to create a new configuration: ++ [source,bash,subs="+quotes"] ---- astra config create "**CONFIG_NAME**" --token **APPLICATION_TOKEN** ---- - ++ .Result [%collapsible] ==== @@ -344,13 +347,13 @@ astra config create "**CONFIG_NAME**" --token **APPLICATION_TOKEN** ---- ==== -Use `astra config use` to change the default configuration that {product} uses when executing commands: - +. Use `astra config use` to change the default configuration that {product} uses when executing commands: ++ [source,bash,subs="+quotes"] ---- astra config use "**CONFIG_NAME**" ---- - ++ .Result [%collapsible] ==== @@ -358,14 +361,15 @@ astra config use "**CONFIG_NAME**" ---- [OK] Section '**CONFIG_NAME**' is set as default. ---- - -Use `astra config list` to confirm that the selected configuration is now the default. ==== -[TIP] -==== +. Optional: Rerun `astra config list` to verify that the new default configuration is set. + +=== Set the configuration for a single run + Every {product} command supports the `--config` option. This option lets you use a different configuration when running a command without changing the default configuration. +For example: [source,bash,subs="+quotes"] ---- @@ -374,12 +378,14 @@ astra user list --config "**CONFIG_NAME**" Alternatively, you can use the `--token` option to supply an application token when running a command. This option lets you use a different application token without having to create a new configuration. +For example: [source,bash,subs="+quotes"] ---- astra user list --token "**APPLICATION_TOKEN**" ---- -==== + +=== Delete a configuration Use `astra config delete` to delete a configuration: @@ -395,18 +401,18 @@ astra config delete "**CONFIG_NAME**" ---- [OK] Section '**CONFIG_NAME**' has been deleted. ---- - -Use `astra config list` to confirm that the selected configuration is now the default. ==== -[NOTE] +[IMPORTANT] ==== -If you delete the default configuration, the {product} does _not_ automatically select a new default configuration. +If you delete the default configuration, the {product} _doesn't_ automatically select a new default configuration. Use the `astra config use` command to select a new default configuration. ==== === `config` options +The following options are available for the `astra config` command: + [source,console] ---- NAME @@ -438,6 +444,8 @@ SYNOPSIS See 'astra help config ' for more information on a specific command. ---- +See the following sections for `config` subcommand options: + .Expand to see all `config create` options [%collapsible] ==== @@ -665,4 +673,4 @@ OPTIONS * xref:ROOT:managing.adoc[] * xref:ROOT:astra-streaming-cli.adoc[] -* xref:ROOT:administration.adoc[] +* xref:ROOT:administration.adoc[] \ No newline at end of file diff --git a/docs-src/astra-cli-core/modules/ROOT/pages/index.adoc b/docs-src/astra-cli-core/modules/ROOT/pages/index.adoc index 9b6cdd1..121220d 100644 --- a/docs-src/astra-cli-core/modules/ROOT/pages/index.adoc +++ b/docs-src/astra-cli-core/modules/ROOT/pages/index.adoc @@ -1,10 +1,10 @@ = {product} :page-layout: landing -The {product} is a free utility that you can use to create and manage Astra resources. -You can use the {product} to perform common platform tasks for {astra_db} and {astra_stream} from the command line or with automation to control your Astra resources at scale. +The {product} is a free utility that you can use to create and manage {product-short} resources. +You can use the {product} to perform common platform tasks for {astra_db} and {astra_stream} from the command line or with automation to control your {product-short} resources at scale. -To make it even easier to integrate Astra into your applications and workflows, the {product} provides seamless integration with the following external tools: +To make it even easier to integrate {product-short} into your applications and workflows, the {product} provides seamless integration with the following external tools: * DSBulk * cqlsh diff --git a/docs-src/astra-cli-core/modules/ROOT/pages/installation.adoc b/docs-src/astra-cli-core/modules/ROOT/pages/installation.adoc index 30b474e..ee1fc4d 100644 --- a/docs-src/astra-cli-core/modules/ROOT/pages/installation.adoc +++ b/docs-src/astra-cli-core/modules/ROOT/pages/installation.adoc @@ -1,5 +1,5 @@ = Install or update the {product} -:description: {product} makes it easier to integrate Astra into your applications and workflows by letting you perform common platform tasks for {astra_db} and {astra_stream} from the command line. +:description: {product} makes it easier to integrate {product-short} into your applications and workflows by letting you perform common platform tasks for {astra_db} and {astra_stream} from the command line. Install the {product} to create and manage {astra_db} databases and {astra_stream} tenants from the command line. @@ -32,11 +32,11 @@ Install the {product} using your preferred method: Homebrew:: + -- -You can use Homebrew to install the {product} on macOS and Linux. +You can use Homebrew to install the {product} on macOS and Linux: -.Prerequisites -* You must have https://brew.sh/[Homebrew] installed. -* On macOS, you must set your macOS app security settings to https://support.apple.com/en-us/102445#openanyway[Allow applications from App Store & Known Developers]. +. On macOS, set your macOS app security settings to https://support.apple.com/en-us/102445#openanyway[Allow applications from App Store & Known Developers]. + +. Make sure https://brew.sh/[Homebrew] is installed. . Make sure Homebrew is up to date: + @@ -66,7 +66,7 @@ Already downloaded: /Users/USERNAME/Library/Caches/Homebrew/downloads/ca763b5f44 ------------------------ ENABLE AUTOCOMPLETION ------------------------- -To enable Bash completion for Astra CLI (and other brew formulae when enable, add the following to your shell configuration file (e.g. ~/.zshrc): +To enable Bash completion for Astra CLI (and other brew formulae when enabled), add the following to your shell configuration file (e.g. ~/.zshrc): if [ -f /opt/homebrew/etc/bash_completion.d ]; then . /opt/homebrew/etc/bash_completion.d @@ -103,17 +103,17 @@ astra --version .Result [%collapsible] ==== +The command returns the {product} version that is installed: + [source,console,subs="+attributes"] ---- {product-version} ---- ==== + -The command returns the {product} version that is installed. -+ include::ROOT:partial$macos-security-notice.adoc[] -. (Optional) If you haven't done so already, enable https://docs.brew.sh/Shell-Completion[`brew` shell completion]. +. Optional: If you haven't done so already, enable https://docs.brew.sh/Shell-Completion[`brew` shell completion]. + The {product} Homebrew formula installs a completion file named `astra` in the Homebrew-managed completions directory. If you have shell completion enabled in Homebrew, your terminal will automatically suggest and complete {product} commands and options as you type them. @@ -122,7 +122,7 @@ If you have shell completion enabled in Homebrew, your terminal will automatical curl:: + -- -You can use `curl` to install the {product} on Linux, macOS, and Windows Subsystem for Linux (WSL). +You can use `curl` to install the {product} on Linux, macOS, and Windows Subsystem for Linux (WSL): . Install the {product}: + @@ -190,14 +190,14 @@ astra --version .Result [%collapsible] ==== +The command returns the {product} version that is installed: + [source,console,subs="+attributes"] ---- {product-version} ---- ==== + -The command returns the {product} version that is installed. -+ include::ROOT:partial$macos-security-notice.adoc[] -- @@ -240,15 +240,15 @@ java -jar astra-cli.jar --version .Result [%collapsible] ==== +The command returns the {product} version that is installed: + [source,console,subs="+attributes"] ---- {product-version} ---- ==== -+ -The command returns the {product} version that is installed. -You can use all options and suffixes on this command when running the JAR file. +You can use all options and suffixes on commands when running the JAR file. For example: [source,bash] @@ -274,19 +274,26 @@ docker --version .Result [%collapsible] ==== +The command returns the Docker version that is installed: + [source,console] ---- Docker version 27.1.1, build 6312585 ---- ==== -. Pull the latest {product} Docker image: +. Pull the latest {product} Docker image (`datastax/astra-cli:latest`): + [source,bash,subs="+attributes"] ---- docker pull datastax/astra-cli ---- + +[TIP] +==== +To pull a specific version of the Docker image, run `docker pull datastax/astra-cli:**TAG**`, replacing `**TAG**` with the version tag of the Docker image you want to pull. +==== ++ .Result [%collapsible] ==== @@ -306,20 +313,6 @@ What's next: View a summary of image vulnerabilities and recommendations → docker scout quickview datastax/astra-cli ---- ==== -+ -[NOTE] -==== -When you run `docker pull datastax/astra-cli`, Docker automatically pulls the latest version of the Docker image (`datastax/astra-cli:latest`). - -To pull a specific version of the Docker image, run the following command: - -[source,bash,subs="+quotes"] ----- -docker pull datastax/astra-cli:**TAG** ----- - -Replace `**TAG**` with the version tag of the Docker image you want to pull. -==== . Confirm that you can successfully run the {product} in a Docker container: + @@ -331,15 +324,15 @@ docker run -rm datastax/astra-cli --version .Result [%collapsible] ==== +The command returns the {product} version that is installed: + [source,console,subs="+attributes"] ---- {product-version} ---- ==== -+ -The command returns the {product} version that is installed. -. (Optional) Run the {product} with a configuration file: +. Optional: Run the {product} with a configuration file: + [source,bash,subs="+quotes"] ---- @@ -357,7 +350,7 @@ docker run -rm -v ~/.astrarc:/work/.astrarc datastax/astra-cli --version This command mounts the `~/.astrarc` file from your local machine to the `/work/.astrarc` file in the Docker container. This lets you use your local configuration file when running the {product} in a Docker container. -. (Optional) Create a shell alias for running the {product} in a Docker container. +. Optional: Create a shell alias for running the {product} in a Docker container. + You can create a shell alias to eliminate the need to include the `docker run` command whenever you want to run the {product} in a Docker container. For example, the following command creates an alias named `astra`: @@ -385,7 +378,6 @@ To set up a new configuration and run your first commands, see xref:getting-star The {product} and its configuration are installed in the following locations: - [cols="1,2"] |=== |File location |Description @@ -443,7 +435,7 @@ brew upgrade datastax/astra-cli/astra-cli ------------------------ ENABLE AUTOCOMPLETION ------------------------- -To enable Bash completion for Astra CLI (and other brew formulae when enable, add the following to your shell configuration file (e.g. ~/.zshrc): +To enable Bash completion for Astra CLI (and other brew formulae when enabled), add the following to your shell configuration file (e.g. ~/.zshrc): if [ -f /opt/homebrew/etc/bash_completion.d ]; then . /opt/homebrew/etc/bash_completion.d @@ -480,14 +472,14 @@ astra --version .Result [%collapsible] ==== +The command returns the {product} version that is installed: + [source,console,subs="+attributes"] ---- {product-version} ---- ==== + -The command returns the {product} version that is installed. -+ include::ROOT:partial$macos-security-notice.adoc[] -- @@ -511,6 +503,8 @@ astra --version .Result [%collapsible] ==== +The command returns the {product} version that is installed: + [source,console,subs="+attributes"] ---- {product-version} @@ -551,7 +545,7 @@ Uninstalling /opt/homebrew/Cellar/astra-cli/{product-version}... (4 files, 61.7M rm -R ~/.astra ---- -. (Optional) Delete the {product} configuration file: +. Optional: Delete the {product} configuration file: + [source,bash] ---- @@ -569,14 +563,14 @@ curl:: rm -R ~/.astra ---- -. (Optional) Delete the {product} configuration file: +. Optional: Delete the {product} configuration file: + [source,bash] ---- rm ~/.astrarc ---- -. (Optional) Remove the {product} from your shell configuration file (for example, `.zshrc` or `.bashrc`). +. Optional: Remove the {product} from your shell configuration file, such as `.zshrc` or `.bashrc`: .. Open your shell configuration file in a text editor. For example: @@ -598,4 +592,4 @@ export ASTRADIR="/Users/USERNAME/.astra/cli" .. Save and close the file. -- -====== +====== \ No newline at end of file diff --git a/docs-src/astra-cli-core/modules/ROOT/pages/managing.adoc b/docs-src/astra-cli-core/modules/ROOT/pages/managing.adoc index de59221..403cbb3 100644 --- a/docs-src/astra-cli-core/modules/ROOT/pages/managing.adoc +++ b/docs-src/astra-cli-core/modules/ROOT/pages/managing.adoc @@ -13,6 +13,9 @@ You can use `**DATABASE_NAME**` instead of `**DATABASE_ID**` in all `astra db` c == Create a database +The {product} can create {db-serverless} and {db-serverless-vector} databases only. +It cannot create {db-classic} databases; however, you can use the {product} to <> about your existing {db-classic} databases. + Use the `astra db create` command to create a new {db-serverless} database: [source,bash,subs="+quotes"] @@ -54,17 +57,11 @@ astra db create **DATABASE_NAME** --vector ---- ==== -[NOTE] -==== -You cannot create {db-classic} databases with the {product}. -However, you can use the {product} to <> about existing {db-classic} databases. -==== - Running `astra db create` without any options deploys the database in an available *Free* region and uses `default_keyspace` as the name for the default keyspace. If the database already exists but is currently xref:astra-db-serverless:databases:database-statuses.adoc[hibernated], the `astra db create` command <> the database. -include::ROOT:partial$async-option.adoc[tags=active] +include::ROOT:partial$async-option-active.adoc[] === `db create` options @@ -210,7 +207,7 @@ astra db create-keyspace **DATABASE_ID** -k **KEYSPACE_NAME** The database enters *Maintenance* status while creating the keyspace. When the database returns to *Active* status, you can use the new keyspace. -include::ROOT:partial$async-option.adoc[tags=active] +include::ROOT:partial$async-option-active.adoc[] [TIP] ====== @@ -281,7 +278,7 @@ Deleting a keyspace permanently deletes all collections, tables, and data in the The database enters *Maintenance* status while it deletes the keyspace along with any collections, tables, and data within the keyspace. -include::ROOT:partial$async-option.adoc[tags=active] +include::ROOT:partial$async-option-active.adoc[] If you delete the default keyspace, {astra_db} automatically selects another keyspace to be the default keyspace. @@ -461,7 +458,7 @@ Use the `astra db create-collection` command to create a new collection in a {db Bring my own embeddings:: + -- -Use this option if you plan to generate your own embeddings and import them when you load data into your collection. +Use these options if you plan to generate your own embeddings and import them when you load data into your collection: [source,bash,subs="+quotes"] ---- @@ -497,35 +494,15 @@ astra db create-collection 58747660-464b-4085-bef2-c3f3e5401e3d \ [OK] Database '58747660-464b-4085-bef2-c3f3e5401e3d' is ready. ---- ==== - -[NOTE] -===== -To create a collection that is _not_ vector-enabled, omit the `-d` and `-m` options. - -[source,bash,subs="+quotes"] ----- -astra db create-collection **DATABASE_ID** -c **COLLECTION_NAME** ----- - -.Result -[%collapsible] -==== -[source,console] ----- -[OK] Collection 'my_collection' as been created from db '58747660-464b-4085-bef2-c3f3e5401e3d' on keyspace 'default_keyspace' -[OK] Database '58747660-464b-4085-bef2-c3f3e5401e3d' is ready. ----- -==== - -You cannot load vector data into a non-vector collection. -===== -- -Use an {astra}-hosted provider:: +Use an {product-short}-hosted provider:: + -- To automatically generate embeddings with xref:astra-db-serverless:databases:embedding-generation.adoc[{astra_db} vectorize], add an embedding provider integration to your collection. -Embedding provider integrations are either {astra}-hosted or external. +Embedding provider integrations are either {product-short}-hosted or external. + +This option uses an {product-short}-hosted provider: [source,bash,subs="+quotes"] ---- @@ -540,7 +517,7 @@ astra db create-collection **DATABASE_ID** \ Replace the following: * `**COLLECTION_NAME**`: The name of the collection you want to create. -* `**PROVIDER_NAME**`: The name of the {astra}-hosted embedding provider. +* `**PROVIDER_NAME**`: The name of the {product-short}-hosted embedding provider. * `**MODEL_NAME**`: The name of the embedding model that you want to use to generate embeddings. * (Optional) `**DIMENSION**`: The number of dimensions that you want the generated vectors to have. You can only set the dimensions if the chosen model supports a range of dimensions. @@ -574,9 +551,9 @@ Use an external provider:: + -- To automatically generate embeddings with xref:astra-db-serverless:databases:embedding-generation.adoc[{astra_db} vectorize], add an embedding provider integration to your collection. -Embedding provider integrations are either {astra}-hosted or external. +Embedding provider integrations are either {product-short}-hosted or external. -To use an external embedding provider, you must add an xref:astra-db-serverless:databases:embedding-generation.adoc#supported-embedding-providers[embedding provider integration] to your {astra_db} organization, and then you can select that embedding provider when you create a collection. +To use an external embedding provider, you must add an xref:astra-db-serverless:databases:embedding-generation.adoc#supported-embedding-providers[embedding provider integration] to your {astra_db} organization, and then you can select that embedding provider when you create a collection: [source,bash,subs="+quotes"] ---- @@ -592,7 +569,7 @@ astra db create-collection **DATABASE_ID** \ Replace the following: * `**COLLECTION_NAME**`: The name of the collection you want to create. -* `**PROVIDER_NAME**`: The name of the {astra}-hosted embedding provider. +* `**PROVIDER_NAME**`: The name of the {product-short}-hosted embedding provider. * `**MODEL_NAME**`: The name of the embedding model that you want to use to generate embeddings. * (Optional) `**PROVIDER_KEY_NAME**`: The name of the provider key that you want to use to authenticate with the external embedding provider. * (Optional) `**DIMENSION**`: The number of dimensions that you want the generated vectors to have. @@ -613,6 +590,28 @@ astra db create-collection 58747660-464b-4085-bef2-c3f3e5401e3d \ -m dot_product ---- +.Result +[%collapsible] +==== +[source,console] +---- +[OK] Collection 'my_collection' as been created from db '58747660-464b-4085-bef2-c3f3e5401e3d' on keyspace 'default_keyspace' +[OK] Database '58747660-464b-4085-bef2-c3f3e5401e3d' is ready. +---- +==== +-- + +Non-vector collection:: ++ +-- +To create a collection that is _not_ vector-enabled, omit the `-d` and `-m` options. +Be aware that non-vector collections don't support vector-dependent functionality like vector search. + +[source,bash,subs="+quotes"] +---- +astra db create-collection **DATABASE_ID** -c **COLLECTION_NAME** +---- + .Result [%collapsible] ==== @@ -1132,12 +1131,10 @@ astra db delete-collection **DATABASE_ID** \ [#manage-tables] == Manage tables -xref:astra-db-serverless:databases:manage-collections.adoc[Tables] store structured data, in the form of rows, in {db-serverless-vector} and {db-serverless} databases. +xref:astra-db-serverless:databases:manage-collections.adoc[Tables] store structured data, as rows and columns, instead of documents. -[NOTE] -==== -The commands described in this section apply only to {db-serverless-vector} databases. -==== +You can create tables in {db-serverless-vector} and {db-serverless} databases. +However, the commands described in this section apply only to {db-serverless-vector} databases. Use the `astra db list-tables` command to get a list of the tables in a {db-serverless-vector} database: @@ -1159,7 +1156,6 @@ astra db list-tables **DATABASE_ID** ---- ==== - Use the `astra db describe-table` command to get information about a specific table: [source,bash,subs="+quotes"] @@ -1459,6 +1455,9 @@ astra db list-embedding-providers **DATABASE_ID** .Result [%collapsible] ====== +The following result is for example purposes only. +Supported embedding providers and options can change. + [source,console] ---- +----------------------+--------------------------+--------+------------+---------+----------+ @@ -1477,8 +1476,6 @@ astra db list-embedding-providers **DATABASE_ID** | mistral | Mistral AI | 1 | 0 | ■ | ■ | +----------------------+--------------------------+--------+------------+---------+----------+ ---- - -include::ROOT:partial$ep-change-admonition.adoc[] ====== Use the `astra db describe-embedding-provider` command to get information about a specific embedding provider integration: @@ -1493,6 +1490,9 @@ The `**PROVIDER_NAME**` is the name listed in the `Key` column in the output of .Result [%collapsible] ====== +The following result is for example purposes only. +Supported embedding providers and options can change. + [source,console] ---- +-------------------+---------------------------------------------------------------------------------------------+ @@ -1521,8 +1521,6 @@ The `**PROVIDER_NAME**` is the name listed in the `Key` column in the output of [OK] Database '58747660-464b-4085-bef2-c3f3e5401e3d' is ready. ---- - -include::ROOT:partial$ep-change-admonition.adoc[] ====== === `db list-embedding-providers` options @@ -1922,67 +1920,13 @@ OPTIONS == Get a list of available {astra_db} regions -Use the `astra db list-regions-serverless` command to get a list of available cloud provider regions that support {db-serverless} databases: +Use the `astra db list-regions-serverless` command to get a list of available regions that support {db-serverless} databases: [source,bash] ---- astra db list-regions-serverless ---- -.Result -[%collapsible] -====== -[source,console] ----- -+-----------------+-------------------------+---------------------------------------+ -| Cloud Provider | Region | Full Name | -+-----------------+-------------------------+---------------------------------------+ -| aws | ap-east-1 | Asia Pacific (Hong Kong) | -| aws | ap-south-1 | Asia Pacific (Mumbai) | -| aws | ap-southeast-1 | Asia Pacific (Singapore) | -| aws | ap-southeast-2 | Asia Pacific (Sydney) | -| aws | ca-central-1 | Canada (Central) | -| aws | ca-west-1 | Canada West (Calgary) | -| aws | eu-central-1 | Europe (Frankfurt) | -| aws | eu-west-1 | Europe (Ireland) | -| aws | eu-west-2 | Europe (London) | -| aws | me-central-1 | Middle East (UAE) | -| aws | sa-east-1 | South America (Sao Paulo) | -| aws | us-east-1 | US East (N. Virginia) | -| aws | us-east-2 | US East (Ohio) | -| aws | us-west-2 | US West (Oregon) | -| azure | australiaeast | Australia East | -| azure | brazilsouth | Brazil South (Sao Paulo) | -| azure | canadacentral | Canada Central (Toronto) | -| azure | centralindia | Central India (Pune) | -| azure | centralus | (US) Central US | -| azure | eastus | US East | -| azure | eastus2 | US East 2 (Virginia) | -| azure | northeurope | Northern Europe (Ireland) | -| azure | westeurope | West Europe | -| azure | westus2 | US West (Washington) | -| azure | westus3 | US West 3 | -| gcp | asia-northeast1 | Asia Northeast1 (Tokyo, Japan) | -| gcp | asia-northeast2 | Osaka, Japan, APAC | -| gcp | asia-south1 | Mumbai, India | -| gcp | australia-southeast1 | Sydney, Australia, APAC | -| gcp | europe-west1 | St. Ghislain, Belgium | -| gcp | europe-west2 | West Europe2 (London, England, UK) | -| gcp | europe-west3 | West Europe3 (Frankfurt, Germany) | -| gcp | europe-west4 | West Europe4 (Eemshaven, Netherlands) | -| gcp | northamerica-northeast1 | Montreal, Quebec | -| gcp | northamerica-northeast2 | Toronto, Ontario | -| gcp | us-central1 | Council Bluffs, Iowa | -| gcp (free-tier) | us-east1 | Moncks Corner, South Carolina | -| gcp | us-east4 | Ashburn, Virginia | -| gcp | us-west1 | The Dalles, Oregon | -| gcp | us-west4 | US West (Las Vegas, USA) | -+-----------------+-------------------------+---------------------------------------+ ----- - -include::ROOT:partial$regions-change-admonition.adoc[] -====== - Use the `astra db list-regions-vector` command to get a list of available cloud provider regions that support {db-serverless-vector} databases: [source,bash] @@ -1990,33 +1934,6 @@ Use the `astra db list-regions-vector` command to get a list of available cloud astra db list-regions-vector ---- -.Result -[%collapsible] -====== -[source,console] ----- -+-----------------+-------------------------+------------------------------------+ -| Cloud Provider | Region | Full Name | -+-----------------+-------------------------+------------------------------------+ -| aws | ap-south-1 | Asia Pacific (Mumbai) | -| aws | ap-southeast-2 | Asia Pacific (Sydney) | -| aws | eu-west-1 | Europe (Ireland) | -| aws | us-east-1 | US East (N. Virginia) | -| aws | us-east-2 | US East (Ohio) | -| azure | australiaeast | Australia East | -| azure | centralindia | Central India (Pune) | -| azure | westeurope | West Europe | -| azure | westus3 | US West 3 | -| gcp | europe-west2 | West Europe2 (London, England, UK) | -| gcp | northamerica-northeast1 | Montreal, Quebec | -| gcp (free-tier) | us-east1 | Moncks Corner, South Carolina | -| gcp | us-east4 | Ashburn, Virginia | -+-----------------+-------------------------+------------------------------------+ ----- - -include::ROOT:partial$regions-change-admonition.adoc[] -====== - Use the `astra db list-regions-classic` command to get a list of available cloud provider regions that support {db-classic} databases: [source,bash] @@ -2026,52 +1943,19 @@ astra db list-regions-classic .Result [%collapsible] -====== -[source,console] +==== +The result for each `list-regions-*` command is a table with `Cloud Provider`, `Region`, and `Full Name` columns. +`Full Name` can be empty or contain the region's name and location (city, state, or country). + +[source,console,subs="+quotes"] ---- -+-----------------+-------------------------+-------------------------------+ -| Cloud Provider | Region | Full Name | -+-----------------+-------------------------+-------------------------------+ -| aws | af-south-1 | Africa (Cape Town) | -| aws | ap-east-1 | Hong Kong | -| aws | ap-south-1 | Asia Pacific (Mumbai) | -| aws | ap-southeast-1 | Asia Pacific (Singapore) | -| aws | ap-southeast-2 | Asia Pacific (Sydney) | -| aws | ca-central-1 | Canada (Central) | -| aws | ca-west-1 | Canada West (Calgary) | -| aws | eu-central-1 | Europe (Frankfurt) | -| aws | eu-west-1 | EU West 1 (Ireland) | -| aws | eu-west-2 | Europe (London) | -| aws | me-central-1 | Middle East (UAE) | -| aws | sa-east-1 | Sao Paulo | -| aws | us-east-1 | US East (N. Virginia) | -| aws | us-east-2 | US East (Ohio) | -| aws | us-west-2 | US West (Oregon) | -| azure | australiaeast | Australia East | -| azure | brazilsouth | Brazil South | -| azure | canadacentral | Canada Central (Toronto) | -| azure | centralindia | Central India | -| azure | centralus | (US) Central US | -| azure | eastus2 | East US 2 (Virginia) | -| azure | northeurope | North Europe | -| azure | southcentralus | South Central US | -| azure | westeurope | West Europe | -| azure | westus2 | West US 2 (Washington) | -| azure | westus3 | West US 3 | -| gcp | asia-northeast2 | Osaka, Japan, APAC | -| gcp | asia-south1 | Mumbai, India | -| gcp | europe-west1 | St. Ghislain, Belgium | -| gcp | northamerica-northeast1 | NA Northeast 1 (Montreal) | -| gcp | southamerica-east1 | Osasco, Sao Paulo, Brazil | -| gcp | us-central1 | US Central (Iowa) | -| gcp (free-tier) | us-east1 | US East (South Carolina) | -| gcp | us-east4 | US East 4 (Virginia) | -| gcp | us-west1 | The Dalles, Oregon | -+-----------------+-------------------------+-------------------------------+-+ ----- - -include::ROOT:partial$regions-change-admonition.adoc[] -====== ++-----------------+---------------------+-------------------------------+ +| Cloud Provider | Region | Full Name | ++-----------------+---------------------+-------------------------------+ +| **PROVIDER** | **REGION** | **NAME** | ++-----------------+---------------------+-------------------------------+ +---- +==== === `db list-regions-serverless` options @@ -2260,37 +2144,17 @@ OPTIONS [#configure-multiple-regions] == Configure multiple regions -You can configure a database to replicate data across multiple regions. -Some benefits of multi-region databases include better data locality and higher availability for multi-region application architectures. -For more information, see xref:astra-db-serverless:databases:manage-regions.adoc[]. - -[IMPORTANT] -==== -Multi-region databases are a premium feature. -Each region added to a database increases the database's costs. -This includes a one-time data replication fee for the new region, and charges for replicating data to all database regions. -For more information, see xref:astra-db-serverless:administration:subscription-plans.adoc[]. -==== - -Use the `astra db create-region` command to add a region to a database: +Use the `astra db create-region` command to deploy a database to an additional region: [source,bash,subs="+quotes"] ---- astra db create-region **DATABASE_ID** -r **REGION** ---- -Replace `**REGION**` with the region you want to add to your database. -The following restrictions apply: - -* You can add only one region at a time. - -* You cannot select a region that the database already uses. - -* You must select a region in the same cloud provider as the database's other regions. -Multi-region databases cannot span multiple cloud providers. +The database enters *Maintenance* status while provisioning and replicating data to the new region. +Some functions are limited while in *Maintenance* status. -* For {db-serverless-vector} databases, you must select a region that supports that database type. -For more information, see xref:astra-db-serverless:databases:regions.adoc[]. +For more information, including requirements and costs for additional regions, see xref:astra-db-serverless:databases:manage-regions.adoc[]. //// // TODO: The command is not working as expected. Must investigate and figure out why it is reporting the following error: [ERROR] UNAVAILABLE: Database 'my_serverless_db' has been found but operation cannot be processed due to invalid state (ACTIVE) expected (ACTIVE) @@ -2304,15 +2168,6 @@ For more information, see xref:astra-db-serverless:databases:regions.adoc[]. ==== //// -[NOTE] -==== -The database enters *Maintenance* status while provisioning and replicating data to the new region. - -While in *Maintenance* status, you cannot add or remove regions, truncate tables, or delete keyspaces, tables, or collections. - -*Maintenance* status doesn't impact reads and writes. -==== - Use the `astra db list-regions` command to list the regions where a database is deployed: [source,bash,subs="+quotes"] @@ -2351,21 +2206,12 @@ astra db delete-region **DATABASE_ID** -r **REGION** ---- ==== -[NOTE] -==== -The database enters *Maintenance* status while deleting the region. - -While in *Maintenance* status, you cannot add or remove regions, truncate tables, or delete keyspaces, tables, or collections. - -*Maintenance* status doesn't impact reads and writes. -==== - [IMPORTANT] ==== You cannot remove the primary (default) region, which is the first region selected when you created the database. When you remove a region, any connections to the deleted region are also removed. -However, to avoid data loss, all data is replicated before the region is deleted. +However, to avoid data loss, all data is replicated to the other regions before the region is deleted. ==== === `db create-region` options @@ -2563,7 +2409,7 @@ astra db resume **DATABASE_ID** Resuming the database may take a few minutes. -include::ROOT:partial$async-option.adoc[tags=active] +include::ROOT:partial$async-option-active.adoc[] === `db resume` options @@ -2650,7 +2496,8 @@ astra db delete **DATABASE_ID** The database enters *Terminating* status while deletion occurs. -include::ROOT:partial$async-option.adoc[tags=terminated] +By default, the command runs synchronously and doesn't return the command prompt until the database reaches *Terminated* or *Error* status. +To run the command _asynchronously_, add the `--async` option. === `db delete` options @@ -2954,9 +2801,9 @@ token@cqlsh> Type `exit` or `quit;` and press kbd:[Return] to exit `cqlsh`. The first time you use the `astra db cqlsh` command, the {product} downloads and installs the `cqlsh` utility to the {product} installation directory (`~/.astra/cqlsh-astra`). -The {product} also downloads the {scb-long} for each database you connect to and stores the {scb} zip files in the `~/.astra/scb` directory. +The {product} also downloads the {scb} for each database you connect to and stores the {scb-short} zip files in the `~/.astra/scb` directory. -[NOTE] +[TIP] ====== If the {product} reports `ModuleNotFoundError`, check that you have a supported version of Python available in your terminal: @@ -3166,13 +3013,16 @@ astra db cqlsh **DATABASE_ID** -e "SOURCE 'sample.cql'" ==== ====== -== Use DataStax Bulk Loader (DSBulk) +== Use DataStax Bulk Loader -The xref:dsbulk:overview:dsbulk-about.adoc[DataStax Bulk Loader] (DSBulk) lets you load, unload, and count data in your database tables. +The xref:dsbulk:overview:dsbulk-about.adoc[DataStax Bulk Loader (DSBulk)] lets you load, unload, and count data in your database tables. The {product} provides built-in DSBulk support by downloading, installing, configuring, and wapping the `dsbulk` utility. The {product} exposes DSBulk functionality through the `astra db load`, `astra db unload`, and `astra db count` commands. +The first time you run `astra db load`, `astra db unload`, or `astra db count` commands, the {product} downloads and installs the `dsbulk` utility to the {product} installation directory (`~/.astra/dsbulk-*`). +The {product} also downloads the {scb} for each database you connect to and stores the {scb-short} zip files in the `~/.astra/scb` directory. + Use the `astra db load` command to load data from a file into a database table: [source,bash,subs="+quotes"] @@ -3310,12 +3160,6 @@ To resume the current operation, re-run it with the same settings, and add the f ---- ==== -[NOTE] -==== -The first time you use one of the `astra db load`, `astra db unload`, or `astra db count` commands, the {product} downloads and installs the `dsbulk` utility to the {product} installation directory (`~/.astra/dsbulk-*`). -The {product} also downloads the {scb-long} for each database you connect to and stores the {scb} zip files in the `~/.astra/scb` directory. -==== - === `db load` options .Expand to see all `db load` options @@ -3610,7 +3454,7 @@ OPTIONS ---- ==== -=== End-to-end example +=== Complete DSBulk example The following end-to-end example shows how to use the {product}'s built-in DSBulk support to load data into a database, get information about the data, and unload the data into CSV files: @@ -4075,7 +3919,7 @@ OPTIONS ---- ==== -=== End-to-end example +=== Complete CDC configuration example The following end-to-end example shows how to use the {product} to create a CDC connection for a table in a {db-serverless} database: @@ -4227,11 +4071,11 @@ astra streaming list-cdc cdc-demo-tenant After you enable CDC on your {db-serverless} database, you can xref:astra-db-serverless:databases:change-data-capture.adoc#connect-a-sink[connect a sink]. -== Download the {scb-cap} +== Download the {scb-brief} The xref:astra-db-serverless:drivers:secure-connect-bundle.adoc[] is a zip file containing security credentials and certificates required for secure mutual TLS (mTLS) connection to your database. -Use the `astra db download-scb` command to download the {scb-long} for a database: +Use the `astra db download-scb` command to download the {scb} for a database: [source,bash,subs="+quotes"] ---- @@ -4248,15 +4092,15 @@ astra db download-scb **DATABASE_ID** -r **REGION_NAME** ==== The `-r **REGION_NAME**` option is required for <>. -If your database is configured with multiple regions, replace `**REGION_NAME**` with the name of the region you want to download the {scb} for. +If your database is configured with multiple regions, replace `**REGION_NAME**` with the name of the region you want to download the {scb-short} for. -By default, the {product} downloads the {scb} to the directory where you run the command and saves the file with the following naming pattern: `scb_**DATABASE-ID**_**REGION-NAME**.zip`. +By default, the {product} downloads the {scb-short} to the directory where you run the command and saves the file with the following naming pattern: `scb_**DATABASE-ID**_**REGION-NAME**.zip`. [WARNING] ==== -Treat the {scb} the same way you would any other sensitive values, such as passwords or tokens. +Treat the {scb-short} the same way you would any other sensitive values, such as passwords or tokens. -The {scb} contains sensitive information that establishes a connection to your database, including key pairs and certificates. +The {scb-short} contains sensitive information that establishes a connection to your database, including key pairs and certificates. ==== === `db download-scb` options @@ -4315,7 +4159,7 @@ OPTIONS ---- ==== -Use the `-r` / `--region` option to download the {scb} for a specific region: +Use the `-r` / `--region` option to download the {scb-short} for a specific region: [source,bash,subs="+quotes"] ---- @@ -4337,7 +4181,7 @@ Use the `astra db list-regions` command to get a list of the region names where For more information, see <>. ==== -Use the `-f` / `--output-file` option to download the {scb} to a specific location and filename: +Use the `-f` / `--output-file` option to download the {scb-short} to a specific location and filename: [source,bash,subs="+quotes"] ---- @@ -4398,13 +4242,16 @@ ASTRA_ORG_TOKEN="AstraCS:FZm..." [WARNING] ==== -The generated `.env` files contains sensitive information, including the application token that the {product} uses to connect to Astra. +The generated `.env` files contains sensitive information, including the application token that the {product} uses to connect to {product-short}. -The {scb} contains sensitive information that establishes a connection to your database, including key pairs and certificates. +The {scb-short} contains sensitive information that establishes a connection to your database, including key pairs and certificates. ==== === `db create-dotenv` options +The directory must already exist before you run the `db create-dotenv` command. +If the directory doesn't exist, the command fails with the error `INVALID_ARGUMENT: Destination folder has not been found`. + .Expand to see all `db create-dotenv` options [%collapsible] ==== @@ -4477,11 +4324,4 @@ astra db create-dotenv **DATABASE_ID** -d ~/tmp ---- [OK] File '/Users/USERNAME/tmp/.env' has been created/amended ---- -==== - -[NOTE] -==== -The directory must already exist before you run the command. -If the directory doesn't exist, the {product} will report the following error: `INVALID_ARGUMENT: Destination folder has not been found`. -==== - +==== \ No newline at end of file diff --git a/docs-src/astra-cli-core/modules/ROOT/partials/async-option-active.adoc b/docs-src/astra-cli-core/modules/ROOT/partials/async-option-active.adoc new file mode 100644 index 0000000..f310874 --- /dev/null +++ b/docs-src/astra-cli-core/modules/ROOT/partials/async-option-active.adoc @@ -0,0 +1,2 @@ +By default, the command runs synchronously and doesn't return the command prompt until the database reaches *Active* or *Error* status. +To run the command _asynchronously_, add the `--async` option. \ No newline at end of file diff --git a/docs-src/astra-cli-core/modules/ROOT/partials/async-option.adoc b/docs-src/astra-cli-core/modules/ROOT/partials/async-option.adoc deleted file mode 100644 index ff76533..0000000 --- a/docs-src/astra-cli-core/modules/ROOT/partials/async-option.adoc +++ /dev/null @@ -1,9 +0,0 @@ -// tag::active[] -By default, the command runs synchronously and doesn't return the command prompt until the database reaches *Active* or *Error* status. -To run the command _asynchronously_, add the `--async` option. -// end::active[] - -// tag::terminated[] -By default, the command runs synchronously and doesn't return the command prompt until the database reaches *Terminated* or *Error* status. -To run the command _asynchronously_, add the `--async` option. -// end::terminated[] \ No newline at end of file diff --git a/docs-src/astra-cli-core/modules/ROOT/partials/ep-change-admonition.adoc b/docs-src/astra-cli-core/modules/ROOT/partials/ep-change-admonition.adoc deleted file mode 100644 index 3048f20..0000000 --- a/docs-src/astra-cli-core/modules/ROOT/partials/ep-change-admonition.adoc +++ /dev/null @@ -1,4 +0,0 @@ -[NOTE] -==== -Supported embedding providers are subject to change and may be different from the sample result. -==== \ No newline at end of file diff --git a/docs-src/astra-cli-core/modules/ROOT/partials/regions-change-admonition.adoc b/docs-src/astra-cli-core/modules/ROOT/partials/regions-change-admonition.adoc deleted file mode 100644 index a658b00..0000000 --- a/docs-src/astra-cli-core/modules/ROOT/partials/regions-change-admonition.adoc +++ /dev/null @@ -1,4 +0,0 @@ -[NOTE] -==== -Supported regions are subject to change and may be different from the sample result. -==== \ No newline at end of file