Interface AstraDbInfo

The database information returned from Db.info.

interface AstraDbInfo {
    apiEndpoint: string;
    cloudProvider: AstraDbCloudProvider;
    environment: "dev" | "prod" | "test";
    id: string;
    keyspaces: string[];
    name: string;
    raw: Record<string, any>;
    region: string;
    status: AstraDbStatus;
}

Hierarchy (view full)

Properties

apiEndpoint cloudProvider environment id keyspaces name raw region status

Properties

apiEndpoint

apiEndpoint: string

cloudProvider

cloudProvider: AstraDbCloudProvider

The cloud provided where the database is hosted.

environment

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

The Astra environment in which the database is running.

id

id: string

The ID of the database.

keyspaces

keyspaces: string[]

The databases's keyspaces; the list may be empty.

name

name: string

The user-given name of the database.

raw

raw: Record<string, any>

The raw response from the DevOps API for the database information.

region

region: string

status

status: AstraDbStatus

The current status of the daatbase.

Settings

Member Visibility

Theme

On This Page

apiEndpointcloudProviderenvironmentidkeyspacesnamerawregionstatus