Drop a keyspace (C#)
Drops a keyspace from a database and deletes all data in that keyspace.
|
You need an application token with permission to interact with the target database, such as the Database Administrator role. For more information, see Get endpoint and token. |
Result
Drops the specified keyspace.
Does not return anything.
Parameters
Use the DropKeyspaceAsync method, which belongs to the IDatabaseAdmin class.
You can also use DropKeyspace, which is the synchronous version of the method.
Method signature
Task DropKeyspaceAsync(
string keyspace, DropKeyspaceOptions options = null
);| Name | Type | Summary |
|---|---|---|
|
|
The name of the keyspace to drop. |
|
Optional.
Options for this operation.
For more information and examples for general options such as timeout, see Customize API interaction.
For options specific to this method, see Method-specific properties of the |
| Name | Type | Summary |
|---|---|---|
|
|
Optional. Whether to wait for the database to become active again before returning. If false, the method returns immediately after issuing the drop request, but you cannot work with the database until it becomes active again. Default: true |
Examples
The following examples demonstrate how to drop a keyspace.
using DataStax.AstraDB.DataApi;
namespace Examples;
public class Program
{
static async Task Main()
{
// Get an existing database
var client = new DataAPIClient();
var database = client.GetDatabase(
"API_ENDPOINT",
"APPLICATION_TOKEN"
);
var databaseAdmin = database.GetAdmin();
await databaseAdmin.DropKeyspaceAsync("KEYSPACE_NAME");
}
}Client reference
For more information, see the client reference.
