Interface AstraFullDatabaseInfo

Overview

Represents the complete metadata returned for an Astra database.

This is returned from AstraDbAdmin.info and AstraAdmin.dbInfo, whereas AstraPartialDatabaseInfo is used for Db.info.

Example

const fullInfo = await db.admin().info(),

// 'ACTIVE'
console.log(fullInfo.status),

// 'https://<db-id>-<region>.apps.astra.datastax.com'
console.log(fullInfo.regions[0].apiEndpoint),

See

AstraBaseDatabaseInfo

interface AstraFullDatabaseInfo {
    cloudProvider: AstraDatabaseCloudProvider;
    createdAt: Date;
    environment: "dev" | "prod" | "test";
    id: string;
    keyspaces: string[];
    lastUsed: Date;
    name: string;
    orgId: string;
    ownerId: string;
    raw: Record<string, any>;
    regions: AstraDatabaseRegionInfo[];
    status: AstraDatabaseStatus;
}

Hierarchy (view full)

Properties

cloudProvider createdAt environment id keyspaces lastUsed name orgId ownerId raw regions status

Properties

cloudProvider

cloudProvider: AstraDatabaseCloudProvider

The cloud provider where the database is hosted.

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

createdAt

createdAt: Date

A timestamp representing when the database was initially created.

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.

lastUsed

lastUsed: Date

A timestamp representing the most recent time the database was accessed (read/write).

name

name: string

The user-provided name of the database.

orgId

orgId: string

The unique organization UUID that owns this database.

ownerId

ownerId: string

The unique user UUID that owns this 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.

regions

regions: AstraDatabaseRegionInfo[]

Information about the regions in which the database is deployed.

It should contain at least one value, but may have more for multi-region deployments.

Contains the region name, API endpoint for that region, and the timestamp when that region was created.

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

cloudProvidercreatedAtenvironmentidkeyspaceslastUsednameorgIdownerIdrawregionsstatus