List index metadata (C#)
|
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 an unordered list of TableIndexMetadata objects that describe each index in the table.
Parameters
Use the ListIndexesAsync method, which belongs to the Table class.
You can also use ListIndexes, which is the synchronous version of the method.
Method signature
public Task<List<TableIndexMetadata>> ListIndexesAsync(
ListIndexesOptions options = null
);| Name | Type | Summary |
|---|---|---|
|
Optional.
General API options for this operation, including the keyspace and timeout.
Keyspace is required unless you specified a working keyspace when instantiating the |
Examples
The following examples demonstrate how to get index metadata for a table.
List index metadata
using System.Text.Json;
using DataStax.AstraDB.DataApi;
using DataStax.AstraDB.DataApi.Core;
namespace Examples;
public class Program
{
static async Task Main()
{
// Get an existing table
var client = new DataAPIClient(
new CommandOptions() { Destination = DataAPIDestination.HCD }
);
var database = client.GetDatabase(
"API_ENDPOINT",
DataAPIClient.UsernamePasswordTokenProvider(
"USERNAME",
"PASSWORD"
),
"KEYSPACE_NAME"
);
var table = database.GetTable("TABLE_NAME");
// List indexes
var indexes = await table.ListIndexesAsync();
Console.WriteLine(JsonSerializer.Serialize(indexes));
}
}Client reference
For more information, see the client reference.
