Interface FullDatabaseInfo

Represents the complete information about a database.

interface FullDatabaseInfo {
    availableActions?: DatabaseAction[];
    cost?: CostInfo;
    cqlshUrl?: string;
    creationTime?: string;
    dataEndpointUrl?: string;
    grafanaUrl?: string;
    graphqlUrl?: string;
    id: string;
    info: DatabaseInfo;
    lastUsageTime?: string;
    message?: string;
    metrics?: DbMetricsInfo;
    observedStatus: DatabaseStatus;
    orgId: string;
    ownerId: string;
    status: DatabaseStatus;
    storage?: DatabaseStorageInfo;
    terminationTime?: string;
}

Properties

availableActions? cost? cqlshUrl? creationTime? dataEndpointUrl? grafanaUrl? graphqlUrl? id info lastUsageTime? message? metrics? observedStatus orgId ownerId status storage? terminationTime?

Properties

Optional availableActions

availableActions?: DatabaseAction[]

The available actions that can be performed on the database

Optional cost

cost?: CostInfo

The cost information for the database

Optional cqlshUrl

cqlshUrl?: string

CQLSH URL for the database

Optional creationTime

creationTime?: string

Creation time, in ISO RFC3339 format

Optional dataEndpointUrl

dataEndpointUrl?: string

REST URL for the database

Optional grafanaUrl

grafanaUrl?: string

Grafana URL for the database

Optional graphqlUrl

graphqlUrl?: string

GraphQL URL for the database

id

id: string

The id of the database

info

info: DatabaseInfo

The user-provided information describing a database

Optional lastUsageTime

lastUsageTime?: string

The last time the database was used, in ISO RFC3339 format

Optional message

message?: string

Message to the user about the cluster

Optional metrics

metrics?: DbMetricsInfo

Basic metrics information about the database

observedStatus

observedStatus: DatabaseStatus

The observed status of the database.

orgId

orgId: string

The id of the organization that owns the database

ownerId

ownerId: string

The id of the owner of the database

status

status: DatabaseStatus

The current status of the database.

Optional storage

storage?: DatabaseStorageInfo

Contains the information about how much storage space a cluster has available

Optional terminationTime

terminationTime?: string

The termination time, in ISO RFC3339 format, if the database was terminated

Settings

Member Visibility

Theme

On This Page

availableActionscostcqlshUrlcreationTimedataEndpointUrlgrafanaUrlgraphqlUrlidinfolastUsageTimemessagemetricsobservedStatusorgIdownerIdstatusstorageterminationTime