Drop an index

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.

Deletes an index from a table in a database.

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

Deletes the specified index.

Does not return anything.

Deletes the specified index.

Returns a promise that resolves once the operation completes.

Deletes the specified index.

Does not return anything.

Deletes the specified index from the a table.

If the command succeeds, the response indicates the success.

Example response:

{
  "status": {
    "ok": 1
  }
}

Parameters

Python
TypeScript
Java
curl

Use the drop_table_index method, which belongs to the astrapy.Database class.

Method signature

drop_table_index(
  name: str,
  *,
  keyspace: str,
  if_exists: bool,
  table_admin_timeout_ms: int,
  request_timeout_ms: int,
  timeout_ms: int,
) -> None

Name Type Summary

Name	Type	Summary
`name`	`str`	The name of the index to delete.
`keyspace`	`str \| None`	Optional if you specified a keyspace when instantiating the `Database` object. The keyspace where you created the index. Default: The database’s working keyspace.
`if_exists`	`bool \| None`	If `True`, and an index with the given name doesn’t exist in the keyspace, then the command succeeds and silently does nothing. In this case, no actual index deletion occurs. If `False` (default), an error occurs if an index with the specified name does not exist in the keyspace.
`table_admin_timeout_ms`	`int \| None`	A timeout, in milliseconds, to impose on the underlying API request. If not provided, the `Database` defaults apply. This parameter is aliased as `request_timeout_ms` and `timeout_ms` for convenience.

name

str

The name of the index to delete.

keyspace

str | None

Optional if you specified a keyspace when instantiating the Database object. The keyspace where you created the index.

Default: The database’s working keyspace.

if_exists

bool | None

If True, and an index with the given name doesn’t exist in the keyspace, then the command succeeds and silently does nothing. In this case, no actual index deletion occurs.

If False (default), an error occurs if an index with the specified name does not exist in the keyspace.

table_admin_timeout_ms

int | None

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

Use the dropTableIndex method, which belongs to the Db class.

Method signature

async dropTableIndex(
  name: string,
  options?: {
    ifExists?: boolean,
    timeout?: number | TimeoutDescriptor,
    keyspace?: string,
  }
): void

Name Type Summary

Name	Type	Summary
`name`	`string`	The name of the index to delete.
`option?`	`TableDropIndexOptions`	The options for this operation.

name

string

The name of the index to delete.

option?

TableDropIndexOptions

The options for this operation.

Options (TableDropIndexOptions):

Name Type Summary

Name	Type	Summary
`keyspace`	`string`	Optional if you specified a keyspace when instantiating the `Db` object. The keyspace containing the index. Default: The database’s working keyspace.
`ifExists?`	`boolean`	If `true`, and an index with the given name doesn’t exist in the keyspace, then the command succeeds and silently does nothing. In this case, no actual index deletion occurs. If `false` (default), an error occurs if an index with the specified name does not exist in the keyspace.
`timeout?`	`number \| TimeoutDescriptor`	The client-side timeout for this operation.

keyspace

string

Optional if you specified a keyspace when instantiating the Db object. The keyspace containing the index.

Default: The database’s working keyspace.

ifExists?

boolean

If true, and an index with the given name doesn’t exist in the keyspace, then the command succeeds and silently does nothing. In this case, no actual index deletion occurs.

If false (default), an error occurs if an index with the specified name does not exist in the keyspace.

timeout?

number | TimeoutDescriptor

The client-side timeout for this operation.

Use the dropTableIndex method, which belongs to the com.datastax.astra.client.databases.Database class.

Method signature

void dropTableIndex(String indexName)

void dropTableIndex(
  String indexName,
  DropTableIndexOptions dropIndexOptions
)

Name Type Summary

Name	Type	Summary
`name`	`str`	Name of the index to drop
`options`	`DropTableIndexOptions`	Specialization of index deletion options, including `ifExists`, 'keyspace` and `timeout`. If `ifExists(true)`, and an index with the given name doesn’t exist in the keyspace, then the command succeeds and silently does nothing. In this case, no actual index deletion occurs. If `ifExists(false)` (default), an error occurs if an index with the specified name does not exist in the keyspace.

name

str

Name of the index to drop

options

DropTableIndexOptions

Specialization of index deletion options, including ifExists, 'keyspace` and timeout.

If ifExists(true), and an index with the given name doesn’t exist in the keyspace, then the command succeeds and silently does nothing. In this case, no actual index deletion occurs.

If ifExists(false) (default), an error occurs if an index with the specified name does not exist in the keyspace.

Use the dropIndex command.

Command signature

curl -sS -L -X POST "API_ENDPOINT/api/json/v1/KEYSPACE_NAME" \
--header "Token: APPLICATION_TOKEN" \
--header "Content-Type: application/json" \
--data '{
  "dropIndex": {
      "name": "INDEX_NAME"
  }
}'

Name Type Summary

Name	Type	Summary
`dropIndex`	`command`	The Data API command to delete an index from a database. It acts as a container for all the attributes and settings required to delete the index.
`name`	`string`	The name of the index to delete.

dropIndex

command

The Data API command to delete an index from a database. It acts as a container for all the attributes and settings required to delete the index.

name

string

The name of the index to delete.

Examples

The following examples demonstrate how to drop an index from a table.

Drop an index

Python
TypeScript
Java
curl

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

# Get a database
client = DataAPIClient(environment=Environment.HCD)
database = client.get_database(
    "API_ENDPOINT",
    token=UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
)

# Drop an index
database.drop_table_index("rating", keyspace="KEYSPACE_NAME")

import {
  DataAPIClient,
  UsernamePasswordTokenProvider,
} from "@datastax/astra-db-ts";

// Get a database
const client = new DataAPIClient({ environment: "hcd" });
const database = client.db("API_ENDPOINT", {
  token: new UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
});

// Drop an index
(async function () {
  await database.dropTableIndex("rating", { keyspace: "KEYSPACE_NAME" });
})();

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.commands.options.DropTableIndexOptions;

public class Example {

  public static void main(String[] args) {
    // Get a database
    DataAPIClient client = DataAPIClients.clientHCD("USERNAME", "PASSWORD");
    Database database = client.getDatabase("API_ENDPOINT", "KEYSPACE_NAME");

    // Drop an index
    database.dropTableIndex("rating", new DropTableIndexOptions());
  }
}

curl -sS -L -X POST "API_ENDPOINT/v1/KEYSPACE_NAME" \
  --header "Token: APPLICATION_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
  "dropIndex": {
      "name": "rating"
  }
}'

Drop an index only if the index exists

Use this option to silently do nothing if an index with the specified name does not exist.

Python
TypeScript
Java
curl

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

# Get a database
client = DataAPIClient(environment=Environment.HCD)
database = client.get_database(
    "API_ENDPOINT",
    token=UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
)

# Drop an index
database.drop_table_index("rating", if_exists=True, keyspace="KEYSPACE_NAME")

import {
  DataAPIClient,
  UsernamePasswordTokenProvider,
} from "@datastax/astra-db-ts";

// Get a database
const client = new DataAPIClient({ environment: "hcd" });
const database = client.db("API_ENDPOINT", {
  token: new UsernamePasswordTokenProvider("USERNAME", "PASSWORD"),
});

// Drop an index
(async function () {
  await database.dropTableIndex("rating", {
    ifExists: true,
    keyspace: "KEYSPACE_NAME",
  });
})();

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.commands.options.DropTableIndexOptions;

public class Example {

  public static void main(String[] args) {
    // Get a database
    DataAPIClient client = DataAPIClients.clientHCD("USERNAME", "PASSWORD");
    Database database = client.getDatabase("API_ENDPOINT", "KEYSPACE_NAME");

    // Drop an index
    DropTableIndexOptions options = new DropTableIndexOptions().ifExists(true);

    database.dropTableIndex("rating", options);
  }
}

This option has no literal equivalent in HTTP. Instead, you can list the index names to see if an index with the name already exists.

Client reference

Python
TypeScript
Java
curl

For more information, see the client reference.

Client reference documentation is not applicable for HTTP.

Drop an index

Result

Parameters

Examples

Drop an index

Drop an index only if the index exists

Client reference

Was this helpful?

Give Feedback