Create a keyspace (TypeScript)
Creates a new keyspace in a database.
Keyspaces are used to store collections and tables in Astra DB Serverless.
|
You need an application token with permission to interact with the target database, such as the Database Administrator role. For more information, see Get endpoint and token. |
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?: {
blocking?: boolean,
updateDbKeyspace?: boolean,
timeout?: number | TimeoutDescriptor,
}
): void| Name | Type | Summary |
|---|---|---|
|
|
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. Keyspace names must follow these rules:
|
|
|
Optional.
The options for this operation. See Properties of |
| Name | Type | Summary |
|---|---|---|
|
|
Optional. Whether to wait for the database to become active again before returning. If false, the method returns immediately after issuing the creation request, but you cannot work with the database until it becomes active again. Default: true |
|
|
Optional.
Whether to set the working keyspace of the |
|
|
Optional. The timeout(s) to apply to this method.
You can specify For more information about the |
Examples
The following examples demonstrate how to create a keyspace.
Create a keyspace
import { DataAPIClient } from "@datastax/astra-db-ts";
// Get a database
const client = new DataAPIClient();
const database = client.db("API_ENDPOINT", {
token: "APPLICATION_TOKEN",
});
// Get an admin object
const admin = database.admin();
// 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 } from "@datastax/astra-db-ts";
// Get a database
const client = new DataAPIClient();
const database = client.db("API_ENDPOINT", {
token: "APPLICATION_TOKEN",
});
// Get an admin object
const admin = database.admin();
// Create a keyspace
(async function () {
await admin.createKeyspace("KEYSPACE_NAME", { updateDbKeyspace: true });
})();Client reference
For more information, see the client reference.
