List index names (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. |
Gets the names of the indexes for a table.
|
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
Returns a promise that resolves to the index names for a table as an unordered list of strings.
Parameters
Use the listIndexes method, which belongs to the Table class.
Method signature
async listIndexes(
options?: ListIndexOptions & {
nameOnly: true,
timeout?: number | TimeoutDescriptor,
}
): TableIndexDescriptor[]| Name | Type | Summary |
|---|---|---|
|
|
The options for this operation.
See Properties of |
| Name | Type | Summary |
|---|---|---|
|
|
Must be |
|
|
Optional. A timeout to impose on the underlying API request. |
Examples
The following examples demonstrate how to get the names of the indexes for a table.
List index names
import {
DataAPIClient,
UsernamePasswordTokenProvider,
} from "@datastax/astra-db-ts";
// Get an existing table
const client = new DataAPIClient({ environment: "hcd" });
const database = client.db("API_ENDPOINT", {
token: new UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
keyspace: "KEYSPACE_NAME",
});
const table = database.table("TABLE_NAME");
// List index names
(async function () {
const result = await table.listIndexes({ nameOnly: true });
console.log(result);
})();Client reference
For more information, see the client reference.
