Plan schema migration
POST /dataset-tables/{tableId}/migrations/plan
POST
/dataset-tables/{tableId}/migrations/plan
Validate a set of migration operations without executing them. Returns what would happen.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” tableId
required
Unique identifier of the table to retrieve
string
Unique identifier of the table to retrieve
Request Body
Section titled “Request Body ”object
operations
required
Array of migration operations to plan
Array
One of:
object
type
required
string
params
required
object
name
required
string
dataType
required
string
nullable
required
boolean
position
integer
defaultValue
object
type
required
string
params
required
object
name
required
string
object
type
required
string
params
required
object
oldName
required
string
newName
required
string
object
type
required
string
params
required
object
name
required
string
oldType
required
string
newType
required
string
object
type
required
string
params
required
object
name
required
string
nullable
required
boolean
object
type
required
string
params
required
object
columns
required
Array<string>
enforced
boolean
object
type
required
string
params
required
object
object
type
required
string
params
required
object
name
required
string
columns
required
Array<string>
indexType
required
string
object
type
required
string
params
required
object
name
required
string
object
type
required
string
params
required
object
name
required
string
column
required
string
config
required
One of:
object
indexType
required
string
metric
required
string
dimensions
required
integer
numPartitions
required
integer
numSubVectors
required
integer
object
indexType
required
string
metric
required
string
dimensions
required
integer
numPartitions
required
integer
numSubVectors
required
integer
maxLevel
required
integer
m
required
integer
efConstruction
required
integer
object
indexType
required
string
metric
required
string
dimensions
required
integer
maxLevel
required
integer
m
required
integer
efConstruction
required
integer
object
indexType
required
string
metric
required
string
dimensions
required
integer
object
type
required
string
params
required
object
name
required
string
Responses
Section titled “ Responses ”Migration plan generated
object
isValid
required
Whether the migration plan is valid
boolean
validationErrors
required
List of validation errors if plan is invalid
Array<string>
estimatedDurationMs
Estimated migration duration in milliseconds
number
indexImpacts
required
How the migration affects existing indexes
Array<object>
object
indexName
required
Name of the affected index
string
impact
required
How the migration affects this index
string
reason
Explanation of why this impact is expected
string
requiresRewrite
Whether the migration requires rewriting table data
boolean
Bad Request - Validation error or invalid input
object
error
required
string
code
string
details
retryable
boolean
Unauthorized - Authentication required or invalid token
object
error
required
string
code
string
details
retryable
boolean
Forbidden - Insufficient permissions
object
error
required
string
code
string
details
retryable
boolean
Not Found - Resource does not exist
object
error
required
string
code
string
details
retryable
boolean