Drop a collection (C#)
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 DropCollectionAsync method, which belongs to the Database class.
You can also use DropCollection, which is the synchronous version of the method.
Method signature
public Task DropCollectionAsync<T>(DropCollectionOptions options = null);public Task DropCollectionAsync(
string collectionName, DropCollectionOptions options = null
);| Name | Type | Summary |
|---|---|---|
|
|
The name of the collection to drop. If not specified, the client attempts to extract it from the |
|
Optional.
General API options for this operation, including the keyspace and timeout.
Keyspace is required unless you specified a working keyspace when instantiating the |
Examples
The following examples demonstrate how to drop a collection.
using DataStax.AstraDB.DataApi;
using DataStax.AstraDB.DataApi.Core;
namespace Examples;
public class Program
{
static async Task Main()
{
// Get a database
var client = new DataAPIClient(
new CommandOptions() { Destination = DataAPIDestination.HCD }
);
var database = client.GetDatabase(
"API_ENDPOINT",
DataAPIClient.UsernamePasswordTokenProvider(
"USERNAME",
"PASSWORD"
),
"KEYSPACE_NAME"
);
// Drop a collection
await database.DropCollectionAsync("COLLECTION_NAME");
}
}Client reference
For more information, see the client reference.
