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

    Interface WithDatabase_cluster_uuItemRequestBuilder

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

    interface WithDatabase_cluster_uuItemRequestBuilder {
        get backups(): BackupsRequestBuilder;
        get ca(): CaRequestBuilder;
        get config(): ConfigRequestBuilder;
        get dbs(): DbsRequestBuilder;
        get events(): EventsRequestBuilder;
        get eviction_policy(): Eviction_policyRequestBuilder;
        get firewall(): FirewallRequestBuilder;
        get indexes(): IndexesRequestBuilder;
        get install_update(): Install_updateRequestBuilder;
        get logsink(): LogsinkRequestBuilder;
        get maintenance(): MaintenanceRequestBuilder;
        get migrate(): MigrateRequestBuilder;
        get onlineMigration(): OnlineMigrationRequestBuilder;
        get pools(): PoolsRequestBuilder;
        get replicas(): ReplicasRequestBuilder;
        get resize(): ResizeRequestBuilder;
        get schemaRegistry(): SchemaRegistryRequestBuilder;
        get sql_mode(): Sql_modeRequestBuilder;
        get topics(): TopicsRequestBuilder;
        get upgrade(): UpgradeRequestBuilder;
        get users(): UsersRequestBuilder;
        delete(requestConfiguration?: RequestConfiguration<object>): Promise<void>;
        get(
            requestConfiguration?: RequestConfiguration<object>,
        ): Promise<undefined | WithDatabase_cluster_uuGetResponse>;
        toDeleteRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        toGetRequestInformation(
            requestConfiguration?: RequestConfiguration<object>,
        ): RequestInformation;
        withUrl(rawUrl: string): WithDatabase_cluster_uuItemRequestBuilder;
    }

    Hierarchy

    Index

    Accessors

    backups ca config dbs events eviction_policy firewall indexes install_update logsink maintenance migrate onlineMigration pools replicas resize schemaRegistry sql_mode topics upgrade users

    Methods

    delete get toDeleteRequestInformation toGetRequestInformation withUrl

    Accessors

    Methods

    • To destroy a specific database, send a DELETE request to /v2/databases/$DATABASE_ID.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 cluster, send a GET request to /v2/databases/$DATABASE_ID.The response will be a JSON object with a database key. This will be set to an object containing the standard database cluster attributes.The embedded connection and private_connection objects will contain the information needed to access the database cluster. For multi-node clusters, the standby_connection and standby_private_connection objects contain the information needed to connect to the cluster's standby node(s).The embedded maintenance_window object will contain information about any scheduled maintenance for the database cluster.

      Parameters

      • OptionalrequestConfiguration: RequestConfiguration<object>

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

      Returns Promise<undefined | WithDatabase_cluster_uuGetResponse>

      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 database, send a DELETE request to /v2/databases/$DATABASE_ID.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 cluster, send a GET request to /v2/databases/$DATABASE_ID.The response will be a JSON object with a database key. This will be set to an object containing the standard database cluster attributes.The embedded connection and private_connection objects will contain the information needed to access the database cluster. For multi-node clusters, the standby_connection and standby_private_connection objects contain the information needed to connect to the cluster's standby node(s).The embedded maintenance_window object will contain information about any scheduled maintenance for the database cluster.

      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