Skip to content
Catalyzed Docs

Create index on table column

POST
/dataset-tables/{tableId}/indexes

Create a new index on a column. Returns an operation for tracking progress.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
tableId
required
string

Request Body

Section titled “Request Body ”
object
indexName
required
string
>= 1 characters <= 255 characters
columnName
required
string
>= 1 characters
indexType
required
string
Allowed values: btree ivf_pq ivf_hnsw_pq ivf_hnsw_sq

Responses

Section titled “ Responses ”

202

Section titled “202 ”

Index creation started

object
operationId
required
string
operationType
required
string
targetType
required
string
targetId
required
string
description
required
string
status
required
string
Allowed values: pending running completed failed cancelled
progressPercent
required
number
progressMessage
string
error
object
code
required
string
message
required
string
createdAt
required
string
startedAt
string
completedAt
string

400

Section titled “400 ”

Bad request - invalid index configuration

404

Section titled “404 ”

Dataset table not found