delete_collection - Delete a collection
delete_collection() deletes the specified collection.
info
This API is only available when you are connected using a client. For more information, see Client.
Prerequisites
-
You have installed pyseekdb. For installation details, see Quick Start.
-
You are connected to the database. For connection details, see Client.
-
The collection you want to delete exists. If it does not exist, an error is returned.
Request parameters
client.delete_collection(name)
| Parameter | Type | Required | Description | Example value |
|---|---|---|---|---|
name | string | Yes | The name of the collection to delete. | my_collection |
Request example
import pyseekdb
# Create a client
client = pyseekdb.Client()
# Delete a collection
client.delete_collection("my_collection")
Response parameters
None