List index metadata (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 information about the indexes associated with a specific 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 an unordered list of TableIndexDescriptor objects that describe each index in the table.
Parameters
Use the listIndexes method, which belongs to the Table class.
Method signature
async listIndexes(
options?: {
nameOnly?: false,
timeout?: number | TimeoutDescriptor,
}
): TableIndexDescriptor[]| Name | Type | Summary |
|---|---|---|
|
|
Optional.
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 index metadata for a table.
List index metadata
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 indexes
(async function () {
const result = await table.listIndexes({ nameOnly: false });
console.log(result);
})();Client reference
For more information, see the client reference.
