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

    Interface DbsRequestBuilder

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

    interface DbsRequestBuilder {
        byDatabase_name(
            database_name: string,
        ): WithDatabase_nameItemRequestBuilder;
        get(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | DbsGetResponse>;
        post(
            body: Database,
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | DbsPostResponse>;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toPostRequestInformation(
            body: Database,
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): DbsRequestBuilder;
    }

    Hierarchy

    Index

    Methods

    byDatabase_name get post toGetRequestInformation toPostRequestInformation withUrl

    Methods

    • To list all of the databases in a clusters, send a GET request to/v2/databases/$DATABASE_ID/dbs.The result will be a JSON object with a dbs key. This will be set to an arrayof database objects, each of which will contain the standard database attributes.Note: Database management is not supported for Caching or Valkey clusters.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | DbsGetResponse>

      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

    post

    • post(
          body: Database,
          requestConfiguration?: RequestConfiguration<object>,
      ): Promise<undefined | DbsPostResponse>

      To add a new database to an existing cluster, send a POST request to/v2/databases/$DATABASE_ID/dbs.Note: Database management is not supported for Caching or Valkey clusters.The response will be a JSON object with a key called db. The value of this will bean object that contains the standard attributes associated with a database.

      Parameters

      • body: Database

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | DbsPostResponse>

      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 list all of the databases in a clusters, send a GET request to/v2/databases/$DATABASE_ID/dbs.The result will be a JSON object with a dbs key. This will be set to an arrayof database objects, each of which will contain the standard database attributes.Note: Database management is not supported for Caching or Valkey clusters.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • To add a new database to an existing cluster, send a POST request to/v2/databases/$DATABASE_ID/dbs.Note: Database management is not supported for Caching or Valkey clusters.The response will be a JSON object with a key called db. The value of this will bean object that contains the standard attributes associated with a database.

      Parameters

      • body: Database

        The request body

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns RequestInformation

    • Parameters

      • rawUrl: string

      Returns DbsRequestBuilder

    Settings

    Member Visibility

    On This Page

    Methods