List index names (C#)
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 the index names for a table as an unordered list of strings.
Parameters
Use the ListIndexNamesAsync method, which belongs to the Table class.
You can also use ListIndexNames, which is the synchronous version of the method.
Method signature
public Task<List<string>> ListIndexNamesAsync(
ListIndexNamesOptions 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 the names of the indexes for a table.
List index names
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 index names
var names = await table.ListIndexNamesAsync();
Console.WriteLine(JsonSerializer.Serialize(names));
}
}Client reference
For more information, see the client reference.
