Drop a collection (Java)
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.
Does not return anything.
Parameters
Use the dropCollection method, which belongs to the com.datastax.astra.client.Database class.
Method signature
void dropCollection(String collectionName)void dropCollection(
String collectionName,
DropCollectionOptions options
)| Name | Type | Summary |
|---|---|---|
|
|
The name of the collection to drop. |
|
Optional.
The options for this operation, including the keyspace and timeouts.
Keyspace is required unless you specified a working keyspace when instantiating the |
Examples
The following examples demonstrate how to drop a collection.
import com.datastax.astra.client.DataAPIClients;
import com.datastax.astra.client.databases.Database;
public class Example {
public static void main(String[] args) {
// Get a database
Database database =
DataAPIClients.clientHCD("USERNAME", "PASSWORD")
.getDatabase("API_ENDPOINT", "KEYSPACE_NAME");
// Drop a collection
database.dropCollection("COLLECTION_NAME");
}
}Client reference
For more information, see the client reference.
