List index metadata (Java)
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 an unordered list of TableIndexDescriptor objects that describe each index in the table.
Parameters
Use the listIndexes method, which belongs to the com.datastax.astra.client.tables.Table class.
Method signature
List<TableIndexDescriptor> listIndexes()List<TableIndexDescriptor> listIndexes(ListIndexesOptions options)| Name | Type | Summary |
|---|---|---|
|
Optional. The options for this operation, including timeout. |
Examples
The following examples demonstrate how to get index metadata for a table.
List index metadata
import com.datastax.astra.client.DataAPIClients;
import com.datastax.astra.client.tables.Table;
import com.datastax.astra.client.tables.definition.rows.Row;
public class Example {
public static void main(String[] args) {
// Get an existing table
Table<Row> table =
DataAPIClients.clientHCD("USERNAME", "PASSWORD")
.getDatabase("API_ENDPOINT", "KEYSPACE_NAME")
.getTable("TABLE_NAME");
// List indexes
table.listIndexes().forEach(index -> System.out.println(index));
}
}Client reference
For more information, see the client reference.
