Drop an index (Java)
|
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.
Signature
Use the dropTableIndex method, which belongs to the com.datastax.astra.client.databases.Database class.
void dropTableIndex(String indexName)void dropTableIndex(
String indexName,
DropTableIndexOptions dropIndexOptions
)Parameters
| Name | Type | Summary |
|---|---|---|
|
|
Name of the index to drop |
|
The options for this operation. See Methods of the |
| Method | Parameters | 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 |
|
|
Optional if you specified a working keyspace when you created the Default: The working keyspace set when you created the |
|
|
Optional. The timeout(s) to apply to HTTP request(s) originating from this method. |
Examples
The following examples demonstrate how to drop an index from a table.
Drop an index
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 an index
database.dropTableIndex("INDEX_NAME");
}
}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.
import com.datastax.astra.client.DataAPIClients;
import com.datastax.astra.client.databases.Database;
import com.datastax.astra.client.tables.commands.options.DropTableIndexOptions;
public class Example {
public static void main(String[] args) {
// Get a database
Database database =
DataAPIClients.clientHCD("USERNAME", "PASSWORD")
.getDatabase("API_ENDPOINT", "KEYSPACE_NAME");
// Drop an index
DropTableIndexOptions options = new DropTableIndexOptions().ifExists(true);
database.dropTableIndex("INDEX_NAME", options);
}
}Client reference
For more information, see the client reference.
