Drop a database (Python)

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 None upon successful completion.

Parameters

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.

Examples

The following examples demonstrate how to drop a database.

from astrapy import DataAPIClient

client = DataAPIClient("APPLICATION_TOKEN")

admin = client.get_admin()

admin.drop_database("DATABASE_ID")

Client reference

For more information, see the client reference.

Drop a database (Python)

Result

Parameters

Examples

Client reference

Was this helpful?

Give Feedback