Execute schema migration

POST

/dataset-tables/{tableId}/migrations

• Production API

Execute a set of migration operations. Returns an operation for tracking progress.

Authorizations

• bearerAuth
• cookieAuth

Parameters

Path Parameters

tableId

required

Unique identifier of the table to retrieve

string

Unique identifier of the table to retrieve

Request Body

object

operations

required

Array of migration operations to execute

Array

>= 1 items

One of:

object

object

type

required

string

Allowed values: add_column

params

required

object

name

required

string

dataType

required

string

nullable

required

boolean

position

integer

nullable

defaultValue

nullable

object

object

type

required

string

Allowed values: drop_column

params

required

object

name

required

string

object

object

type

required

string

Allowed values: rename_column

params

required

object

oldName

required

string

newName

required

string

object

object

type

required

string

Allowed values: change_column_type

params

required

object

name

required

string

oldType

required

string

newType

required

string

object

object

type

required

string

Allowed values: alter_column_nullability

params

required

object

name

required

string

nullable

required

boolean

object

object

type

required

string

Allowed values: set_primary_key

params

required

object

columns

required

Array<string>

>= 1 items

enforced

boolean

default: true

object

object

type

required

string

Allowed values: drop_primary_key

params

required

object

object

object

type

required

string

Allowed values: add_scalar_index

params

required

object

name

required

string

columns

required

Array<string>

indexType

required

string

Allowed values: btree bitmap

object

object

type

required

string

Allowed values: drop_scalar_index

params

required

object

name

required

string

object

object

type

required

string

Allowed values: add_vector_index

params

required

object

name

required

string

column

required

string

config

required

One of:

object

object

indexType

required

string

Allowed values: ivf_pq

metric

required

string

Allowed values: l2 cosine dot hamming

dimensions

required

integer

numPartitions

required

integer

numSubVectors

required

integer

object

object

indexType

required

string

Allowed values: ivf_hnsw_pq

metric

required

string

Allowed values: l2 cosine dot hamming

dimensions

required

integer

numPartitions

required

integer

numSubVectors

required

integer

maxLevel

required

integer

m

required

integer

efConstruction

required

integer

object

object

indexType

required

string

Allowed values: hnsw

metric

required

string

Allowed values: l2 cosine dot hamming

dimensions

required

integer

maxLevel

required

integer

m

required

integer

efConstruction

required

integer

object

object

indexType

required

string

Allowed values: flat

metric

required

string

Allowed values: l2 cosine dot hamming

dimensions

required

integer

object

object

type

required

string

Allowed values: drop_vector_index

params

required

object

name

required

string

description

Optional description of the migration

string

Responses

202

Migration started

object

operationId

required

Unique identifier for the operation

string

operationType

required

Type of operation (compact, build_index, etc.)

string

targetType

required

Type of target resource (table, index)

string

targetId

required

ID of the target resource

string

description

required

Human-readable description of the operation

string

status

required

Current operation status (pending, running, succeeded, failed)

string

Allowed values: pending running completed failed cancelled

progressPercent

required

Progress percentage (0-100)

number

progressMessage

Human-readable progress message

string

error

Error details if operation failed

object

code

required

Error code

string

message

required

Human-readable error message

string

createdAt

required

When the operation was created

string

startedAt

When the operation started running

string

completedAt

When the operation completed

string

400

Bad Request - Validation error or invalid input

object

error

required

string

code

string

details

nullable

retryable

boolean

401

Unauthorized - Authentication required or invalid token

object

error

required

string

code

string

details

nullable

retryable

boolean

403

Forbidden - Insufficient permissions

object

error

required

string

code

string

details

nullable

retryable

boolean

404

Not Found - Resource does not exist

object

error

required

string

code

string

details

nullable

retryable

boolean