Drop a database (TypeScript)

Terminating a database permanently deletes all of its data, including automatic backups. You cannot undo this action.

Deletes a database and erases all data stored in it.

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

Deletes the specified database and erases all data stored in the database.

Returns a promise that resolves once the operation completes.

Parameters

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

Method signature

async dropDatabase(
  db: Db | string,
  options?: {
    blocking?: boolean,
    timeout?: number | TimeoutDescriptor,
  }
): void;

Name Type Summary

Name	Type	Summary
`db`	`Db \| string`	The ID of the target database, or a corresponding `Db` object.
`options`	`object`	Optional. The options for this operation. See Properties of `options` for more details.

db

Db | string

The ID of the target database, or a corresponding Db object.

options

object

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

Properties of `options`
Name	Type	Summary
`blocking`	`boolean`	Optional. Whether to wait for the database to be fully deleted before returning. If false, the method returns immediately after issuing the deletion request. Default: true
`timeout`	`number` \| `TimeoutDescriptor`	Optional. A timeout to impose on the underlying API request.

Examples

The following examples demonstrate how to drop a database.

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

const client = new DataAPIClient("APPLICATION_TOKEN");

const admin = client.admin();

(async function () {
  await admin.dropDatabase("DATABASE_ID");
})();

Client reference

For more information, see the client reference.

Drop a database (TypeScript)

Result

Parameters

Examples

Client reference

Was this helpful?

Give Feedback