Skip to content

DOC-6080 migration prep #51

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
aimurphy merged 1 commit into from
Sep 22, 2026
Merged

DOC-6080 migration prep #51

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

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions in-progress/managing.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,8 @@ Running `astra db create` without any options deploys the database in an availab

If the database already exists but is currently xref:astra-db-serverless:databases:database-statuses.adoc[hibernated], the `astra db create` command <<resume-database,resumes>> the database.

include::ROOT:partial$async-option-active.adoc[]
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 create` options

Expand Down Expand Up @@ -195,7 +196,8 @@ 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-active.adoc[]
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.

[TIP]
====
Expand Down Expand Up @@ -257,7 +259,8 @@ 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-active.adoc[]
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.

If you delete the default keyspace, {astra-db} automatically selects another keyspace to be the default keyspace.

Expand Down Expand Up @@ -2239,7 +2242,8 @@ astra db resume **DATABASE_ID**

Resuming the database may take a few minutes.

include::ROOT:partial$async-option-active.adoc[]
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 resume` options

Expand Down
27 changes: 6 additions & 21 deletions in-progress/quickstart-databases.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ Get a list of available regions for database creation.
You can create {db-serverless-vector} and {db-serverless} databases.

If your organization uses xref:astra-db-serverless:administration:provisioned-capacity-units.adoc[PCU groups], you assign the database to a PCU group when creating the database.
====

Create a database:

Expand All @@ -40,25 +39,19 @@ Parameters:

| `db_name`
| `String`
a| The database name.

Database names must follow these rules:

include::common:ROOT:partial$database-name-rules.adoc[]
| The database name.

| `region`
| `String` (OPTIONAL)
a| A valid xref:databases:regions.adoc[cloud provider region], depending on your xref:administration:subscription-plans.adoc[plan] and the database type.

include::astra-db-serverless:databases:partial$get-regions-endpoint.adoc[]
| A valid xref:databases:regions.adoc[cloud provider region], depending on your xref:administration:subscription-plans.adoc[plan] and the database type.

| `cloud`
| `String` (OPTIONAL)
| The cloud provider (`gcp,azure,aws`) to use for the database.

| `keyspace`
| `String` (OPTIONAL)
a| The name of the database's initial keyspace.
| The name of the database's initial keyspace.
If omitted, the default is `default_keyspace`.

| `--if-not-exists`
Expand All @@ -70,7 +63,6 @@ Check for an existing database with the same configuration.
| `flag` (OPTIONAL)
| By default, the operation is synchronous and waits for the database to become active.
Include this option to make the operation asynchronous.

|===

[IMPORTANT]
Expand Down Expand Up @@ -142,7 +134,6 @@ List all of your databases:
astra db list
----

.Result
[source,console,subs="+quotes"]
----
+---------------------+--------------+-----------+-------+---+-----------+
Expand All @@ -151,13 +142,11 @@ astra db list
| astra_db_client | *DB_ID* | us-east1 | gcp | ■ | ACTIVE |
+---------------------+--------------+-----------+-------+---+-----------+
----
//ID truncated to prevent bad wrapping.

== Drop a database

include::common:ROOT:partial$terminate-db-warn.adoc[]

Delete a database and erase all data stored in it.
Permanently delete a database, erasing all data stored in it and all backups.
You cannot undo this action.

Delete a database by ID:

Expand Down Expand Up @@ -209,11 +198,7 @@ See xref:databases:create-database.adoc#get-db-id[Get your database ID].

| `KEYSPACE_NAME`
| `String`
a| The unique name for the keyspace.

Keyspace names must follow these rules:

include::common:ROOT:partial$keyspace-name-rules.adoc[]
| The unique name for the keyspace.
|===

== List keyspaces
Expand Down
10 changes: 5 additions & 5 deletions modules/ROOT/pages/install.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,14 +137,14 @@ To install the {product} on Windows, you can use a scripted installation or bina

. Run the following command to install the latest version of the {product} to the default location:
+
[source,powershell]
[source,shell]
----
powershell -c "irm https://ibm.biz/astra-cli-win | iex"
----
+
To install the {product} to a custom location, export the `ASTRA_HOME` environment variable before running the installation command, replacing `**INSTALLATION_DIRECTORY**` with the full path to your preferred installation directory:
+
[source,powershell,subs="+quotes"]
[source,shell,subs="+quotes"]
----
$env:ASTRA_HOME = "**INSTALLATION_DIRECTORY**"
----
Expand All @@ -153,7 +153,7 @@ $env:ASTRA_HOME = "**INSTALLATION_DIRECTORY**"

. Run the `astra` command from any directory to verify successful installation:
+
[source,powershell]
[source,shell]
----
astra
----
Expand All @@ -166,7 +166,7 @@ The response includes available commands and options for the {product}.

. Extract the zip file into the directory where you want to install the {product}:
+
[source,powershell,subs="+quotes"]
[source,shell,subs="+quotes"]
----
powershell -C "Expand-Archive -Path astra-windows-x86_64.zip -DestinationPath **INSTALLATION_DIRECTORY** -Force"
----
Expand All @@ -180,7 +180,7 @@ For more information, see the https://learn.microsoft.com/en-us/powershell/modul

. Run the `astra` command from any directory to verify successful installation:
+
[source,powershell]
[source,shell]
----
astra
----
Expand Down
Loading
Loading