Drop an index (TypeScript)
|
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.
Returns a promise that resolves once the operation completes.
Parameters
Use the dropTableIndex method, which belongs to the Db class.
Method signature
async dropTableIndex(
name: string,
options?: {
ifExists?: boolean,
timeout?: number | TimeoutDescriptor,
keyspace?: string,
}
): void| Name | Type | Summary |
|---|---|---|
|
|
The name of the index to delete. |
|
|
Optional.
The options for this operation. See Properties of |
| Name | Type | Summary |
|---|---|---|
|
|
Optional if you specified a working keyspace when you created the Default: The working keyspace set when you created the |
|
|
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. A timeout to impose on the underlying API request. |
Examples
The following examples demonstrate how to drop an index from a table.
Drop an index
import {
DataAPIClient,
UsernamePasswordTokenProvider,
} from "@datastax/astra-db-ts";
// Get a database
const client = new DataAPIClient({ environment: "hcd" });
const database = client.db("API_ENDPOINT", {
token: new UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
keyspace: "KEYSPACE_NAME",
});
// Drop an index
(async function () {
await 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 {
DataAPIClient,
UsernamePasswordTokenProvider,
} from "@datastax/astra-db-ts";
// Get a database
const client = new DataAPIClient({ environment: "hcd" });
const database = client.db("API_ENDPOINT", {
token: new UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
keyspace: "KEYSPACE_NAME",
});
// Drop an index
(async function () {
await database.dropTableIndex("INDEX_NAME", {
ifExists: true,
});
})();Client reference
For more information, see the client reference.
