Interface AstraBaseDatabaseInfo

Overview

Represents the common properties shared by both AstraPartialDatabaseInfo and AstraFullDatabaseInfo.

This includes identifiers, basic configuration, status, and environment details.

interface AstraBaseDatabaseInfo {
    cloudProvider: AstraDatabaseCloudProvider;
    environment: "dev" | "prod" | "test";
    id: string;
    keyspaces: string[];
    name: string;
    raw: Record<string, any>;
    status: AstraDatabaseStatus;
}

Hierarchy (view full)

Properties

cloudProvider environment id keyspaces name raw status

Properties

cloudProvider

cloudProvider: AstraDatabaseCloudProvider

The cloud provider where the database is hosted.

Valid values include 'AWS', 'GCP', and 'AZURE'.

environment

environment: "dev" | "prod" | "test"

The Astra environment in which the database is running.

Not relevant for most users' usage.

id

id: string

The unique UUID of the database.

keyspaces

keyspaces: string[]

The list of keyspaces currently present in the database.

The list may technically be empty in rare corner cases, if they have all been deleted, but it is quite unlikely.

name

name: string

The user-provided name of the database.

raw

raw: Record<string, any>

The full raw response received from the DevOps API when querying for database metadata.

This field is provided for inspection or debugging, and contains fields not explicitly typed/present in this interface.

status

status: AstraDatabaseStatus

The current status of the database.

Common values include:

  • 'PENDING'
  • 'ACTIVE'
  • 'DELETING'
  • 'HIBERNATED'
  • 'TERMINATED'

Status values indicate the provisioning/operational state of the database.

AstraDatabaseStatus contains a large amount of possible statuses (though many are unlikely), but the enumeration is open to other statuses not mentioned.

Settings

Member Visibility

Theme

On This Page

cloudProviderenvironmentidkeyspacesnamerawstatus