Plan schema migration
POST
/dataset-tables/{tableId}/migrations/plan
Validate a set of migration operations without executing them. Returns what would happen.
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” tableId
required
string
Request Body
Section titled “Request Body ”object
operations
required
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
Responses
Section titled “ Responses ”Migration plan generated
object
isValid
required
boolean
validationErrors
required
Array<string>
estimatedDurationMs
number
indexImpacts
required
Array<object>
object
indexName
required
string
impact
required
string
reason
string
requiresRewrite
boolean
Bad request - invalid migration operations
Dataset table not found