@digitalocean/dots - v1.0.1
    Preparing search index...

    Interface MigrateRequestBuilder

    Builds and executes requests for operations under /v2/databases/{database_cluster_uuid}/migrate

    interface MigrateRequestBuilder {
        put(
            body: MigratePutRequestBody,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<void>;
        toPutRequestInformation(
            body: MigratePutRequestBody,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): MigrateRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    put toPutRequestInformation withUrl

    Methods

    • To 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 aregion attribute.A successful request will receive a 202 Accepted status code with no body inresponse. Querying the database cluster will show that its status attributewill now be set to migrating. This will transition back to online when themigration has completed.

      Parameters

      • body: MigratePutRequestBody

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

        Configuration for the request such as headers, query parameters, and middleware options.

      Returns Promise<void>

      error when the service returns a 401 status code

      error when the service returns a 404 status code

      error when the service returns a 429 status code

      error when the service returns a 500 status code

      error when the service returns a 4XX or 5XX status code

    • To 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 aregion attribute.A successful request will receive a 202 Accepted status code with no body inresponse. Querying the database cluster will show that its status attributewill now be set to migrating. This will transition back to online when themigration has completed.

      Parameters

      • body: MigratePutRequestBody

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

        Configuration for the request such as headers, query parameters, and middleware options.

      Returns RequestInformation

    • Parameters

      • rawUrl: string

      Returns MigrateRequestBuilder

    Settings

    Member Visibility

    On This Page

    Methods