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
C#
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.

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
C#
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`	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`	Optional. Whether the command should silently succeed even if an index with the given name does not exist in the keyspace and no index was dropped. Default: false
`table_admin_timeout_ms`	`int`	Optional. A timeout, in milliseconds, for the underlying HTTP request. If not provided, the `Database` setting is used. This parameter is aliased as `request_timeout_ms` and `timeout_ms` for convenience.

name

str

The name of the index to delete.

keyspace

str

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

Optional. Whether the command should silently succeed even if an index with the given name does not exist in the keyspace and no index was dropped.

Default: false

table_admin_timeout_ms

int

Optional. A timeout, in milliseconds, for the underlying HTTP request. If not provided, the Database setting is used. 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.
`options`	`TableDropIndexOptions`	Optional. The options for this operation. See Properties of `options` for more details.

name

string

The name of the index to delete.

options

TableDropIndexOptions

Optional. The options for this operation. See Properties of options for more details.

Properties of `options`
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`	Optional. Whether the command should silently succeed even if an index with the given name does not exist in the keyspace and no index was dropped. Default: false
`timeout`	`number` \| `TimeoutDescriptor`	Optional. A timeout to impose on the underlying API request.

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`	The options for this operation. See Methods of the `DropTableIndexOptions` class for more details.

name

str

Name of the index to drop

options

DropTableIndexOptions

The options for this operation. See Methods of the DropTableIndexOptions class for more details.

Methods of the `DropTableIndexOptions` class
Method	Parameters	Summary
`ifExists()`	`boolean`	Optional. Whether the command should silently succeed even if an index with the given name does not exist in the keyspace and no index was dropped. Default: false
`keyspace()`	`String`	Optional if you specified a keyspace when instantiating the `Database` object. The keyspace in which to create the user-defined type. Default: The database’s working keyspace.
`timeout()`	`long` \| `Duration`	Optional. The timeout(s) to apply to HTTP request(s) originating from this method.

Use the DropTableIndexAsync method, which belongs to the Database class. You can also use DropTableIndex, which is the synchronous version of the method.

Method signature

public Task DropTableIndexAsync(
  string indexName, DropTableIndexOptions options = null
);

Name Type Summary

Name	Type	Summary
`indexName`	`string`	The name of the index to delete.
`options`	`DropTableIndexOptions`	Optional. Options for this operation. For more information and examples for general options such as timeout, see Customize API interaction. For options specific to this method, see Method-specific properties of the `DropTableIndexOptions` class.

indexName

string

The name of the index to delete.

options

DropTableIndexOptions

Optional. Options for this operation. For more information and examples for general options such as timeout, see Customize API interaction. For options specific to this method, see Method-specific properties of the DropTableIndexOptions class.

Method-specific properties of the `DropTableIndexOptions` class
Name	Type	Summary
`IfExists`	`bool`	Optional. Whether the command should silently succeed even if an index with the given name does not exist in the keyspace and no index was dropped. Default: false

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
`name`	`string`	The name of the index to delete.

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
C#
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("INDEX_NAME", 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("INDEX_NAME", {
    keyspace: "KEYSPACE_NAME",
  });
})();

import com.datastax.astra.client.DataAPIClients;
import com.datastax.astra.client.databases.Database;

public class Example {

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

    // Drop an index
    database.dropTableIndex("INDEX_NAME");
  }
}

using DataStax.AstraDB.DataApi;
using DataStax.AstraDB.DataApi.Core;
using DataStax.AstraDB.DataApi.Tables;

namespace Examples;

public class Program
{
  static async Task Main()
  {
    // Get an existing database
    var client = new DataAPIClient(
      new CommandOptions() { Destination = DataAPIDestination.HCD }
    );

    var database = client.GetDatabase(
      "API_ENDPOINT",
      DataAPIClient.UsernamePasswordTokenProvider(
        "USERNAME",
        "PASSWORD"
      ),
      "KEYSPACE_NAME"
    );

    // Drop an index
    await database.DropTableIndexAsync(
      "INDEX_NAME",
      new DropTableIndexOptions() { IfExists = true }
    );
  }
}

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

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
C#
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(
    "INDEX_NAME", 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("INDEX_NAME", {
    ifExists: true,
    keyspace: "KEYSPACE_NAME",
  });
})();

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
    Database database =
        DataAPIClients.clientHCD("USERNAME", "PASSWORD")
            .getDatabase("API_ENDPOINT", "KEYSPACE_NAME");

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

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

using DataStax.AstraDB.DataApi;
using DataStax.AstraDB.DataApi.Core;
using DataStax.AstraDB.DataApi.Tables;

namespace Examples;

public class Program
{
  static async Task Main()
  {
    // Get an existing database
    var client = new DataAPIClient(
      new CommandOptions() { Destination = DataAPIDestination.HCD }
    );

    var database = client.GetDatabase(
      "API_ENDPOINT",
      DataAPIClient.UsernamePasswordTokenProvider(
        "USERNAME",
        "PASSWORD"
      ),
      "KEYSPACE_NAME"
    );

    // Drop an index
    await database.DropTableIndexAsync(
      "INDEX_NAME",
      new DropTableIndexOptions() { IfExists = true }
    );
  }
}

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
C#
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