Drop an index (Python)
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
Deletes the specified index.
Does not return anything.
Parameters
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 |
|---|---|---|
|
|
The name of the index to delete. |
|
|
Optional. The keyspace where you created the index. Default: The working keyspace for the database.
This is |
|
|
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 |
|
|
Optional.
A timeout, in milliseconds, for the underlying HTTP request.
If not provided, the |
Examples
The following examples demonstrate how to drop an index from a table.
Drop an index
from astrapy import DataAPIClient
# Get a database
client = DataAPIClient()
database = client.get_database(
"API_ENDPOINT", token="APPLICATION_TOKEN"
)
# Drop an index
database.drop_table_index("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.
from astrapy import DataAPIClient
# Get a database
client = DataAPIClient()
database = client.get_database(
"API_ENDPOINT", token="APPLICATION_TOKEN"
)
# Drop an index
database.drop_table_index("INDEX_NAME", if_exists=True)Client reference
For more information, see the client reference.
