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

    Interface UpgradeRequestBuilder

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

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

    Hierarchy

    Index

    Methods

    put toPutRequestInformation withUrl

    Methods

    • To upgrade the major version of a database, send a PUT request to /v2/databases/$DATABASE_ID/upgrade, specifying the target version.A successful request will receive a 204 No Content status code with no body in response.

      Parameters

      • body: Version2

        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 upgrade the major version of a database, send a PUT request to /v2/databases/$DATABASE_ID/upgrade, specifying the target version.A successful request will receive a 204 No Content status code with no body in response.

      Parameters

      • body: Version2

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • Parameters

      • rawUrl: string

      Returns UpgradeRequestBuilder

    Settings

    Member Visibility

    On This Page

    Methods