Create a database (TypeScript)

Creates a database.

To replicate a database to additional datacenters, see Deploy an Astra DB Serverless database to multiple regions.

You need an application token with permission to create and configure databases, such as the Organization Administrator role.

For more information, see Get endpoint and token.

Result

Creates a database and returns a promise that resolves to an AstraDbAdmin object that can perform administrative actions on the newly-created database.

Parameters

Use the createDatabase method, which belongs to the AstraAdmin class.

Method signature

async createDatabase(
  config: {
    name: string,
    cloudProvider: AstraDatabaseCloudProvider,
    region: string,
    keyspace?: string,
    pcuGroupUUID?: string,
    tier?: string,
    capacityUnits?: number,
    dbType?: 'vector' | 'nonvector',
  },
  options: {
    blocking?: boolean,
    timeout?: number | TimeoutDescriptor,
    dbOptions?: DbOptions
  }
): AstraDbAdmin;

Name Type Summary

Name	Type	Summary
`config`	`AstraDatabaseConfig`	The database configuration. See Properties of `config` for more details.
`options`	`CreateAstraDatabaseOptions`	Optional. The options for this operation. See Properties of `options` for more details.

config

AstraDatabaseConfig

The database configuration. See Properties of config for more details.

options

CreateAstraDatabaseOptions

Optional. The options for this operation. See Properties of options for more details.

Name Type Summary

name

string

The name for the database.

Database names must follow these rules:

Must start and end with a letter or number
Can contain letters, numbers, and the special characters & + - _ ( ) < > . , @
Cannot exceed 50 characters

cloudProvider

AstraDatabaseCloudProvider

The cloud provider that should host the database. Can be one of: AWS, GCP, AZURE.

region

string

The cloud provider region in which to create the database.

The available regions depend on your Astra plan and the database type. To find available regions, see Find available regions (TypeScript).

keyspace

string

Optional. The name for the database’s initial keyspace.

Default: default_keyspace

pcuGroupUUID

string

Optional. The ID of the PCU group to use for provisioning the database. The specified PCU group must have the same cloud provider and region as the database. Only applicable for organizations that use PCU groups.

Default: No PCU group

dbType

'vector' | 'nonvector'

Optional. Whether the database is a Serverless (vector) database or a Serverless (non-vector) database.

To create a Serverless (vector) database, set this parameter to vector.

To create a Serverless (non-vector) database, set it to nonvector.

The Data API is supported for Serverless (vector) and Serverless (non-vector) databases generally. However, vector and reranking functionalities aren’t compatible with all databases, tables, or collections.

Default: vector

tier

string

Optional. The database tier.

If specified, must be serverless.

Default: serverless

capacityUnits

number

Optional. The number of capacity units for the database. This is unrelated to PCU group capacity.

If specified, must be 1.

Default: 1

Properties of `options`
Name	Type	Summary
`blocking`	`boolean`	Optional. Whether to wait for the database to become active before returning. If false, the method returns immediately after issuing the creation request, but you cannot work with the database until it becomes active. Default: true
`timeout`	`number` \| `TimeoutDescriptor`	Optional. A timeout to impose on the underlying API request.
`options`	`DbOptions`	Optional. A specification of options to override the defaults inherited from the `AstraAdmin`. Use this to customize the interaction of the client with the database admin. For example, you can change the default timeouts or token.

Examples

The following examples demonstrate how to create a database.

import { DataAPIClient } from "@datastax/astra-db-ts";

const client = new DataAPIClient("APPLICATION_TOKEN");

const admin = client.admin();

(async function () {
  await admin.createDatabase({
    name: "DATABASE_NAME",
    cloudProvider: "GCP",
    region: "us-east1",
  });
})();

Client reference

For more information, see the client reference.

Create a database (TypeScript)

Result

Parameters

Examples

Client reference

Was this helpful?

Give Feedback