Interface DatabaseConfig

Represents the options for creating a database.

Field

name - Name of the database--user friendly identifier

Field

cloudProvider - Cloud provider where the database lives

Field

region - Cloud region where the database is located

interface DatabaseConfig {
    cloudProvider?: DatabaseCloudProvider;
    keyspace?: string;
    name: string;
    namespace?: string;
    region: string;
}

Properties

cloudProvider? keyspace? name namespace? region

Properties

Optional cloudProvider

cloudProvider?: DatabaseCloudProvider

Cloud provider where the database lives

Optional keyspace

keyspace?: string

The default keyspace to use for the database.

name

name: string

Name of the database (user-friendly identifier)

Optional namespace

namespace?: string

The default keyspace to use for the database.

This is now a deprecated alias for the strictly equivalent DatabaseConfig.keyspace, and will be removed in an upcoming major version.

https://docs.datastax.com/en/astra-db-serverless/api-reference/client-versions.html#version-1-5

Deprecated

region

region: string

The cloud region where the database is located.

Settings

Member Visibility

Theme

On This Page

cloudProviderkeyspacenamenamespaceregion