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

    Interface ConfigRequestBuilder

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

    interface ConfigRequestBuilder {
        get(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | ConfigGetResponse>;
        patch(
            body: Database_config,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | ArrayBuffer>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toPatchRequestInformation(
            body: Database_config,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): ConfigRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    get patch toGetRequestInformation toPatchRequestInformation withUrl

    Methods

    • Shows configuration parameters for an existing database cluster by sending a GET request to/v2/databases/$DATABASE_ID/config.The response is a JSON object with a config key, which is set to an objectcontaining any database configuration parameters.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | ConfigGetResponse>

      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 update the configuration for an existing database cluster, send a PATCH request to/v2/databases/$DATABASE_ID/config.

      Parameters

      • body: Database_config

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | ArrayBuffer>

      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

    • Shows configuration parameters for an existing database cluster by sending a GET request to/v2/databases/$DATABASE_ID/config.The response is a JSON object with a config key, which is set to an objectcontaining any database configuration parameters.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • To update the configuration for an existing database cluster, send a PATCH request to/v2/databases/$DATABASE_ID/config.

      Parameters

      • body: Database_config

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • Parameters

      • rawUrl: string

      Returns ConfigRequestBuilder

    Settings

    Member Visibility

    On This Page

    Methods