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

    Interface WithReplica_nameItemRequestBuilder

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

    interface WithReplica_nameItemRequestBuilder {
        get promote(): PromoteRequestBuilder;
        delete(requestConfiguration?: RequestConfiguration<object>): Promise<void>;
        get(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | WithReplica_nameGetResponse>;
        toDeleteRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): WithReplica_nameItemRequestBuilder;
    }

    Hierarchy

    Index

    Accessors

    promote

    Methods

    delete get toDeleteRequestInformation toGetRequestInformation withUrl

    Accessors

    Methods

    • To destroy a specific read-only replica, send a DELETE request to /v2/databases/$DATABASE_ID/replicas/$REPLICA_NAME.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 show information about an existing database replica, send a GET request to /v2/databases/$DATABASE_ID/replicas/$REPLICA_NAME.Note: Read-only replicas are not supported for Caching or Valkey clusters.The response will be a JSON object with a replica key. This will be set to an object containing the standard database replica attributes.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | WithReplica_nameGetResponse>

      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 destroy a specific read-only replica, send a DELETE request to /v2/databases/$DATABASE_ID/replicas/$REPLICA_NAME.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

    • To show information about an existing database replica, send a GET request to /v2/databases/$DATABASE_ID/replicas/$REPLICA_NAME.Note: Read-only replicas are not supported for Caching or Valkey clusters.The response will be a JSON object with a replica key. This will be set to an object containing the standard database replica attributes.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    Settings

    Member Visibility

    On This Page

    Accessors
    Methods