List index names

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

Python
TypeScript
Java
curl

Returns the index names for a table as an unordered list of strings.

Example response:

['m_vector_index', 'winner_index', 'score_index']

Returns a promise that resolves to the index names for a table as an unordered list of strings.

Example resolved response:

['score_idx', 'winner_idx', 'm_vector_idx']

Returns the index names for a table as an unordered list of strings.

Returns the index names for a table as an unordered list of strings in the status.indexes field of the response.

Example response:

{
  "status": {
    "indexes": [
      "index_name_1",
      "index_name_2"
    ]
  }
}

Parameters

Python
TypeScript
Java
curl

Use the list_index_names method, which belongs to the astrapy.Table class.

Method signature

list_index_names(
  *,
  table_admin_timeout_ms: int,
  request_timeout_ms: int,
  timeout_ms: int,
) -> list[str]

Name Type Summary

Name	Type	Summary
`table_admin_timeout_ms`	`int \| None`	A timeout, in milliseconds, to impose on the underlying API request. If not provided, the Table defaults apply. This parameter is aliased as `request_timeout_ms` and `timeout_ms` for convenience.

table_admin_timeout_ms

int | None

A timeout, in milliseconds, to impose on the underlying API request. If not provided, the Table defaults apply. This parameter is aliased as request_timeout_ms and timeout_ms for convenience.

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

Name	Type	Summary
`option`	`ListIndexOptions`	The options for this operation

option

ListIndexOptions

The options for this operation

Options (ListIndexOptions):

Name Type Summary

Name	Type	Summary
`nameOnly`	`boolean`	If true, the response includes only index names. If false or undefined, the response includes index names and metadata.
`timeout?`	`number \| TimeoutDescriptor`	The client-side timeout for this operation.

nameOnly

boolean

If true, the response includes only index names. If false or undefined, the response includes index names and metadata.

timeout?

number | TimeoutDescriptor

The client-side timeout for this operation.

Use the listIndexesNames method, which belongs to the com.datastax.astra.client.tables.Table class.

Method signature

List<String> listIndexesNames()

List<String> listIndexesNames(ListIndexesOptions listIndexesOptions)

Name Type Summary

Name	Type	Summary
`options`	`ListIndexesOptions`	Specialization of index creation options.

options

ListIndexesOptions

Specialization of index creation options.

Use the listIndexes command.

Command signature

curl -sS -L -X POST "API_ENDPOINT/api/json/v1/KEYSPACE_NAME/TABLE_NAME" \
--header "Token: APPLICATION_TOKEN" \
--header "Content-Type: application/json" \
--data '{
  "listIndexes": {
    "options": {
      "explain": false
    }
  }
}'

Name Type Summary

Name	Type	Summary
`listIndexes`	`command`	The Data API command to get a list of indexes associated with a table in a database.
`options.explain`	`boolean`	If true, the response includes index names and metadata. If false or unset, the response includes only index names.

listIndexes

command

The Data API command to get a list of indexes associated with a table in a database.

options.explain

boolean

If true, the response includes index names and metadata. If false or unset, the response includes only index names.

Examples

The following examples demonstrate how to get the names of the indexes for a table.

List index names

Python
TypeScript
Java
curl

from astrapy import DataAPIClient
from astrapy.authentication import UsernamePasswordTokenProvider
from astrapy.constants import Environment

# Get an existing table
client = DataAPIClient(environment=Environment.HCD)
database = client.get_database(
    "API_ENDPOINT",
    token=UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
)
table = database.get_table("TABLE_NAME", keyspace="KEYSPACE_NAME")

# List index names
result = table.list_index_names()
print(result)

The client does not support this method. Use a direct HTTP request instead, as demonstrated in the curl tab.

import com.datastax.astra.client.DataAPIClient;
import com.datastax.astra.client.DataAPIClients;
import com.datastax.astra.client.databases.Database;
import com.datastax.astra.client.tables.Table;
import com.datastax.astra.client.tables.definition.rows.Row;
import java.util.List;

public class Example {

  public static void main(String[] args) {
    // Get an existing table
    DataAPIClient client = DataAPIClients.clientHCD("USERNAME", "PASSWORD");
    Database database = client.getDatabase("API_ENDPOINT", "KEYSPACE_NAME");
    Table<Row> table = database.getTable("TABLE_NAME");

    // List index names
    List<String> result = table.listIndexesNames();

    System.out.println(result);
  }
}

curl -sS -L -X POST "API_ENDPOINT/v1/KEYSPACE_NAME/TABLE_NAME" \
  --header "Token: APPLICATION_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
  "listIndexes": {
    "options": {
      "explain": false
    }
  }
}'

Client reference

Python
TypeScript
Java
curl

For more information, see the client reference.

Client reference documentation is not applicable for HTTP.

List index names

Result

Parameters

Examples

List index names

Client reference

Was this helpful?

Give Feedback