Drop a database

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

Python
TypeScript
Java
curl

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

Returns None upon successful completion.

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

Returns a promise that resolves once the operation completes.

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

Returns a Boolean indicating whether the database was successfully deleted.

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

Returns 202 Accepted, indicating that the database deletion has been initiated.

The database isn’t instantly deleted, and the termination process can take some time. To monitor the termination process, you can check the database status in the Astra Portal.

Parameters

Python
TypeScript
Java
curl

Use the drop_database method, which belongs to the AstraDBAdmin class.

Method signature

drop_database(
  id: str,
  *,
  wait_until_active: bool,
  database_admin_timeout_ms: int,
  request_timeout_ms: int,
  timeout_ms: int,
) -> None

Name Type Summary

Name	Type	Summary
`id`	`str`	The ID of the database to drop.
`wait_until_active`	`bool`	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
`database_admin_timeout_ms`	`int`	Optional. A timeout, in milliseconds, to impose on the underlying API request. If not provided, the `AstraDBAdmin` defaults apply. This parameter is aliased as `request_timeout_ms` and `timeout_ms` for convenience.

id

str

The ID of the database to drop.

wait_until_active

bool

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

database_admin_timeout_ms

int

Optional. A timeout, in milliseconds, to impose on the underlying API request. If not provided, the AstraDBAdmin defaults apply.

This parameter is aliased as request_timeout_ms and timeout_ms for convenience.

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.

Use the dropDatabase method, which belongs to the com.datastax.astra.client.admin.AstraDBAdmin class.

Method signature

boolean dropDatabase(UUID databaseId);

boolean dropDatabase(String databaseName);

Name Type Summary

Name	Type	Summary
`databaseId`	`UUID`	The ID of the database to delete.
`databaseName`	`String`	The name of the database to delete.

databaseId

UUID

The ID of the database to delete.

databaseName

String

The name of the database to delete.

Use the DevOps API to delete a database. This operation is a POST request with no body.

The application token must have sufficient permissions to perform the requested operations, such as the Organization Administrator role.

Command signature

curl -sS -L -X POST "https://api.astra.datastax.com/v2/databases/DATABASE_ID/terminate" \
--header "Authorization: Bearer APPLICATION_TOKEN" \
--header "Content-Type: application/json"

Examples

The following examples demonstrate how to drop a database.

Python
TypeScript
Java
curl

from astrapy import DataAPIClient

client = DataAPIClient("APPLICATION_TOKEN")

admin = client.get_admin()

admin.drop_database("DATABASE_ID")

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

const client = new DataAPIClient("APPLICATION_TOKEN");

const admin = client.admin();

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

import com.datastax.astra.client.DataAPIClient;
import com.datastax.astra.client.admin.AstraDBAdmin;
import java.util.UUID;

public class Example {
  public static void main(String[] args) {
    DataAPIClient client = new DataAPIClient("APPLICATION_TOKEN");

    AstraDBAdmin admin = client.getAdmin();

    admin.dropDatabase(UUID.fromString("DATABASE_ID"));
  }
}

curl -sS -L -X POST "https://api.astra.datastax.com/v2/databases/DATABASE_ID/terminate" \
--header "Authorization: Bearer APPLICATION_TOKEN" \
--header "Content-Type: application/json"

Client reference

Python
TypeScript
Java
curl

For more information, see the client reference.

Client reference documentation is not applicable for HTTP.

Drop a database

Result

Parameters

Examples

Client reference

Was this helpful?

Give Feedback