Drop a keyspace (TypeScript)
Drops a keyspace from a database and deletes all data in that keyspace.
Result
Drops the specified keyspace.
Returns a promise that resolves once the operation completes.
Parameters
Use the dropKeyspace method, which belongs to the DataAPIDbAdmin class.
Method signature
async dropKeyspace(
keyspace: string,
options?: {
timeout?: number | TimeoutDescriptor,
}
): void| Name | Type | Summary |
|---|---|---|
|
|
The name of the keyspace to drop. |
|
|
Optional.
The options for this operation. See Properties of |
| Name | Type | Summary |
|---|---|---|
|
|
Optional. The timeout(s) to apply to this method.
You can specify For more information about the |
Examples
The following examples demonstrate how to drop 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" });
// Drop a keyspace
(async function () {
await admin.dropKeyspace("KEYSPACE_NAME");
})();Client reference
For more information, see the client reference.
