Drop a keyspace (Python)

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

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.
`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.

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
from astrapy.authentication import UsernamePasswordTokenProvider
from astrapy.constants import Environment

# Get a database
client = DataAPIClient(environment=Environment.HCD)
database = client.get_database(
    "API_ENDPOINT",
    token=UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
)

# 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