Drop a specific index

Drop the specified index from table id.

REST NAMESPACE ONLY REST namespace does not use a request body for this operation. The DropTableIndexRequest information is passed in the following way:

• id: pass through path parameter of the same name
• index_name: pass through path parameter of the same name

POST /v1/table/{id}/index/{index_name}/drop

Error

A valid request URL is required to generate request examples

200

{
  "transaction_id": "<string>"
}

Authorizations

OAuth2BearerAuthApiKeyAuth

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

id · string · required

string identifier of an object in a namespace, following the Lance Namespace spec. When the value is equal to the delimiter, it represents the root namespace. For example, v1/namespace/$/list performs a ListNamespace on the root namespace.

index_name · string · required

Name of the index to drop

Query Parameters

delimiter · string

An optional delimiter of the string identifier, following the Lance Namespace spec. When not specified, the $ delimiter must be used.

branch · string

Optional branch to target. When not specified, the main branch is used. Used by branch-scoped operations that cannot carry a branch field in their request body (Arrow IPC stream and bodyless operations). Operations with a JSON request body carry branch as a body field instead.

Response

200

application/json

Index drop operation result

Response for drop index operation

transaction_id · string

Optional transaction identifier