Skip to content

Database Migration

Properties

NAME TYPE DESCRIPTION
$id
string

Database migration ID.

$createdAt
string

Migration creation time in ISO 8601 format.

$updatedAt
string

Migration update time in ISO 8601 format.

projectId
string

Project ID that owns the migrating database.

databaseId
string

Logical database ID being migrated.

specification
string

Dedicated compute specification provisioned for the migration target.

phase
string

Migration phase. Possible values: pending, provisioned, capturing, backfilling, catching_up, verifying, ready_to_cutover, cutover, soaking, done, failed, rolled_back.

attempt
integer

Number of times a migration step has failed and been recorded.

lastError
string

Reason the most recent migration step failed, empty while none has.

lagDocuments
integer

Number of documents still pending replication to the target.

verifiedAt
string

Time the migrated data was verified against the source in ISO 8601 format.

cutoverAt
string

Time routing was flipped to the target in ISO 8601 format.

soakUntil
string

Time the post-cutover soak window ends in ISO 8601 format.

autoCutover
boolean

Whether the migration cuts over automatically once ready. Set when the migration is created and never changed afterwards, so it always reports what was asked for.

cutoverRequested
boolean

Whether a cutover has been requested and not yet attempted. Set by the cutover endpoint and cleared when the attempt is made, so a cutover that fails a check parks the migration again rather than retrying on its own.

paused
boolean

Whether the migration is paused.

Example