Skip to main content

migrations

Overview

Namemigrations
TypeResource
Iddigitalocean.databases.migrations

Fields

NameDatatypeDescription
idstringThe ID of the most recent migration.
created_atstringThe time the migration was initiated, in ISO 8601 format.
statusstringThe current status of the migration.

Methods

NameAccessible byRequired ParamsDescription
get_migrationStatusSELECTdatabase_cluster_uuidTo retrieve the status of the most recent online migration, send a GET request to /v2/databases/$DATABASE_ID/online-migration.
delete_onlineMigrationDELETEdatabase_cluster_uuid, migration_idTo stop an online migration, send a DELETE request to /v2/databases/$DATABASE_ID/online-migration/$MIGRATION_ID.

A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed.
update_onlineMigrationEXECdatabase_cluster_uuidTo start an online migration, send a PUT request to /v2/databases/$DATABASE_ID/online-migration endpoint. Migrating a cluster establishes a connection with an existing cluster and replicates its contents to the target cluster. Online migration is only available for MySQL, PostgreSQL, and Redis clusters.
update_regionEXECdatabase_cluster_uuid, data__regionTo migrate a database cluster to a new region, send a PUT request to
/v2/databases/$DATABASE_ID/migrate. The body of the request must specify a
region attribute.

A successful request will receive a 202 Accepted status code with no body in
response. Querying the database cluster will show that its status attribute
will now be set to migrating. This will transition back to online when the
migration has completed.