Create an index on a table
Create an index on a table column for faster search operations.
Supports vector indexes (IVF_FLAT, IVF_HNSW_SQ, IVF_PQ, etc.) and scalar indexes (BTREE, BITMAP, FTS, etc.).
Index creation is handled asynchronously.
Use the ListTableIndices and DescribeTableIndexStats operations to monitor index creation progress.
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
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.
Query Parameters
An optional delimiter of the string identifier, following the Lance Namespace spec.
When not specified, the $ delimiter must be used.
Body
Index creation request
Name of the column to create index on
Type of index to create (e.g., BTREE, BITMAP, LABEL_LIST, IVF_FLAT, IVF_PQ, IVF_HNSW_SQ, FTS)
Optional name for the index. If not provided, a name will be auto-generated.
Distance metric type for vector indexes (e.g., l2, cosine, dot)
Optional FTS parameter for position tracking
Optional FTS parameter for base tokenizer
Optional FTS parameter for language
Optional FTS parameter for maximum token length
x >= 0Optional FTS parameter for lowercase conversion
Optional FTS parameter for stemming
Optional FTS parameter for stop word removal
Optional FTS parameter for ASCII folding
Response
Index created successfully
Response for create index operation
Optional transaction identifier