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

    Interface WithDatabase_nameItemRequestBuilder

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

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

    Hierarchy

    Index

    Methods

    delete get toDeleteRequestInformation toGetRequestInformation withUrl

    Methods

    • To delete a specific database, send a DELETE request to/v2/databases/$DATABASE_ID/dbs/$DB_NAME.A status of 204 will be given. This indicates that the request was processedsuccessfully, but that no response body is needed.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<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 cluster, send a GET request to/v2/databases/$DATABASE_ID/dbs/$DB_NAME.Note: Database management is not supported for Caching or Valkey clusters.The response will be a JSON object with a db key. This will be set to an objectcontaining the standard database attributes.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | WithDatabase_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 delete a specific database, send a DELETE request to/v2/databases/$DATABASE_ID/dbs/$DB_NAME.A status of 204 will be given. This indicates that the request was processedsuccessfully, but that no response body is needed.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 show information about an existing database cluster, send a GET request to/v2/databases/$DATABASE_ID/dbs/$DB_NAME.Note: Database management is not supported for Caching or Valkey clusters.The response will be a JSON object with a db key. This will be set to an objectcontaining the standard database 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

    Methods