Drop a keyspace (Python)

Drops a keyspace from a database and deletes all data in that keyspace.

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

Drops the specified keyspace.

Does not return anything.

Parameters

Use the drop_keyspace method, which belongs to the astrapy.DataAPIDatabaseAdmin class.

Method signature

drop_keyspace(
  name: str,
  *,
  keyspace_admin_timeout_ms: int,
  request_timeout_ms: int,
  timeout_ms: int,
) -> None

Name Type Summary

Name	Type	Summary
`name`	`str`	The name of the keyspace to drop.
`wait_until_active`	`bool`	Optional. Whether to wait for the database to become active again before returning. If false, the method returns immediately after issuing the drop request, but you cannot work with the database until it becomes active again. Default: true
`keyspace_admin_timeout_ms`	`int`	Optional. A timeout, in milliseconds, to impose on the underlying API request. If not provided, the `DataAPIDatabaseAdmin` defaults apply. This parameter is aliased as `request_timeout_ms` and `timeout_ms` for convenience.

name

str

The name of the keyspace to drop.

wait_until_active

bool

Optional. Whether to wait for the database to become active again before returning. If false, the method returns immediately after issuing the drop request, but you cannot work with the database until it becomes active again.

Default: true

keyspace_admin_timeout_ms

int

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

This parameter is aliased as request_timeout_ms and timeout_ms for convenience.

Examples

The following examples demonstrate how to drop a keyspace.

from astrapy import DataAPIClient

# Get a database
client = DataAPIClient()
database = client.get_database(
    "API_ENDPOINT", token="APPLICATION_TOKEN"
)

# Get an admin object
admin = database.get_database_admin()

# Drop a keyspace
admin.drop_keyspace("KEYSPACE_NAME")

Client reference

For more information, see the client reference.

Drop a keyspace (Python)

Result

Parameters

Examples

Client reference

Was this helpful?

Give Feedback