Drop a collection (Python)

Deletes a collection from a database and erases all data stored in the collection.

Ready to write code? See the examples for this method to get started. If you are new to the Data API, check out the quickstart.

Result

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

The method returns None upon successful completion.

Parameters

Use the drop_collection method, which belongs to the astrapy.Database class.

Method signature

drop_collection(
    name: str,
    *,
    keyspace: str,
    collection_admin_timeout_ms: int,
    request_timeout_ms: int,
    timeout_ms: int,
) -> None:

The database’s drop_collection method is equivalent to the collection’s own collection.drop() method.

Name Type Summary

Name	Type	Summary
`name`	`str`	The name of the collection to drop.
`keyspace`	`str`	Optional if you specified a working keyspace when you created the `Database` object. The keyspace containing the collection. Default: The working keyspace set when you created the `Database` object, if one was provided.
`collection_admin_timeout_ms`	`int`	A timeout, in milliseconds, for the underlying HTTP request. If not provided, the `Database` setting is used. This parameter is aliased as `request_timeout_ms` and `timeout_ms` for convenience.

name

str

The name of the collection to drop.

keyspace

str

Optional if you specified a working keyspace when you created the Database object. The keyspace containing the collection.

Default: The working keyspace set when you created the Database object, if one was provided.

collection_admin_timeout_ms

int

A timeout, in milliseconds, for the underlying HTTP request. If not provided, the Database setting is used. This parameter is aliased as request_timeout_ms and timeout_ms for convenience.

Examples

The following examples demonstrate how to drop a collection.

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"),
    keyspace="KEYSPACE_NAME",
)

# Drop a collection
database.drop_collection("COLLECTION_NAME")

Client reference

For more information, see the client reference.

Drop a collection (Python)

Result

Parameters

Examples

Client reference

Was this helpful?

Give Feedback