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

    Interface PromoteRequestBuilder

    Builds and executes requests for operations under /v2/databases/{database_cluster_uuid}/replicas/{replica_name}/promote

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

    Hierarchy

    Index

    Methods

    put toPutRequestInformation withUrl

    Methods

    • To promote a specific read-only replica, send a PUT request to /v2/databases/$DATABASE_ID/replicas/$REPLICA_NAME/promote.Note: Read-only replicas are not supported for Caching or Valkey clusters.A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed.

      Parameters

      • 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 promote a specific read-only replica, send a PUT request to /v2/databases/$DATABASE_ID/replicas/$REPLICA_NAME/promote.Note: Read-only replicas are not supported for Caching or Valkey clusters.A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • Parameters

      • rawUrl: string

      Returns PromoteRequestBuilder

    Settings

    Member Visibility

    On This Page

    Methods