Drop an index (C#)
|
Tables with the Data API are currently in public preview. Development is ongoing, and the features and functionality are subject to change. Hyper-Converged Database (HCD), and the use of such, is subject to the DataStax Preview Terms. |
Deletes an index from a table in a database.
|
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 index.
Does not return anything.
Parameters
Use the DropTableIndexAsync method, which belongs to the Database class.
You can also use DropTableIndex, which is the synchronous version of the method.
Method signature
public Task DropTableIndexAsync(
string indexName, DropTableIndexOptions options = null
);| Name | Type | Summary |
|---|---|---|
|
|
The name of the index to delete. |
|
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 the command should silently succeed even if an index with the given name does not exist in the keyspace and no index was dropped. Default: false |
Examples
The following examples demonstrate how to drop an index from a table.
Drop an index
using DataStax.AstraDB.DataApi;
using DataStax.AstraDB.DataApi.Core;
using DataStax.AstraDB.DataApi.Tables;
namespace Examples;
public class Program
{
static async Task Main()
{
// Get an existing database
var client = new DataAPIClient(
new CommandOptions() { Destination = DataAPIDestination.HCD }
);
var database = client.GetDatabase(
"API_ENDPOINT",
DataAPIClient.UsernamePasswordTokenProvider(
"USERNAME",
"PASSWORD"
),
"KEYSPACE_NAME"
);
// Drop an index
await database.DropTableIndexAsync(
"INDEX_NAME",
new DropTableIndexOptions() { IfExists = true }
);
}
}Drop an index only if the index exists
Use this option to silently do nothing if an index with the specified name does not exist.
using DataStax.AstraDB.DataApi;
using DataStax.AstraDB.DataApi.Core;
using DataStax.AstraDB.DataApi.Tables;
namespace Examples;
public class Program
{
static async Task Main()
{
// Get an existing database
var client = new DataAPIClient(
new CommandOptions() { Destination = DataAPIDestination.HCD }
);
var database = client.GetDatabase(
"API_ENDPOINT",
DataAPIClient.UsernamePasswordTokenProvider(
"USERNAME",
"PASSWORD"
),
"KEYSPACE_NAME"
);
// Drop an index
await database.DropTableIndexAsync(
"INDEX_NAME",
new DropTableIndexOptions() { IfExists = true }
);
}
}Client reference
For more information, see the client reference.
