Create a keyspace (TypeScript)

Creates a new keyspace in a database.

Keyspaces are used to store collections and tables in Hyper-Converged Database (HCD).

Result

Creates the specified keyspace.

Returns a promise that resolves once the operation completes.

Parameters

Use the createKeyspace method, which belongs to the DataAPIDbAdmin class.

Method signature

async createKeyspace(
  keyspace: string,
  options?: {
    replication?: KeyspaceReplicationOptions,
    updateDbKeyspace?: boolean,
    timeout?: number | TimeoutDescriptor,
  }
): void

Name Type Summary

keyspace

string

The name of the keyspace to create.

If a keyspace with the name already exists, a new keyspace isn’t created, and the command succeeds.

options

CreateDataAPIKeyspaceOptions

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

Properties of `options`
Name	Type	Summary
`replication`	`KeyspaceReplicationOptions`	Optional. Specifies the options for data replication across database nodes. For an example, see Create a keyspace and specify replication options. Default: `{class: 'SimpleStrategy', replicationFactor: 1}`
`updateDbKeyspace`	`boolean`	Optional. Whether to set the working keyspace of the `Db` object that created the current `DbAdmin` object to the new keyspace.
`timeout`	`number` \| `TimeoutDescriptor`	Optional. The timeout(s) to apply to this method. You can specify `requestTimeoutMs` and `keyspaceAdminTimeoutMs`. For more information about the `TimeoutDescriptor`, see TypeScript client internals: TimeoutDescriptor. If you specify a number instead of a `TimeoutDescriptor` object, that number will be applied to both `requestTimeoutMs` and `keyspaceAdminTimeoutMs`.

Examples

The following examples demonstrate how to create a keyspace.

Create a keyspace

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

// Get a database
const client = new DataAPIClient({ environment: "hcd" });
const database = client.db("API_ENDPOINT", {
  token: new UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
});

// Get an admin object
const admin = database.admin({ environment: "hcd" });

// Create a keyspace
(async function () {
  await admin.createKeyspace("KEYSPACE_NAME");
})();

Create a keyspace and set it as the working keyspace for the database

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

// Get a database
const client = new DataAPIClient({ environment: "hcd" });
const database = client.db("API_ENDPOINT", {
  token: new UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
});

// Get an admin object
const admin = database.admin({ environment: "hcd" });

// Create a keyspace
(async function () {
  await admin.createKeyspace("KEYSPACE_NAME", { updateDbKeyspace: true });
})();

Create a keyspace and specify replication options

For more information about data replication, see Data replication.

Example using SimpleStrategy:

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

// Get a database
const client = new DataAPIClient({ environment: "hcd" });
const database = client.db("API_ENDPOINT", {
  token: new UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
});

// Get an admin object
const admin = database.admin({ environment: "hcd" });

// Create a keyspace
(async function () {
  await admin.createKeyspace("KEYSPACE_NAME", {
    replication: {
      class: "SimpleStrategy",
      replicationFactor: 3,
    },
  });
})();

Example using NetworkTopologyStrategy:

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

// Get a database
const client = new DataAPIClient({ environment: "hcd" });
const database = client.db("API_ENDPOINT", {
  token: new UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
});

// Get an admin object
const admin = database.admin({ environment: "hcd" });

// Create a keyspace
(async function () {
  await admin.createKeyspace("KEYSPACE_NAME", {
    replication: {
      class: "NetworkTopologyStrategy",
      datacenter1: 3,
      datacenter2: 2,
    },
  });
})();

Client reference

For more information, see the client reference.

Was this helpful?