Skip to main content

dbs

Creates, updates, deletes, gets or lists a dbs resource.

Overview

Namedbs
TypeResource
Iddigitalocean.databases.dbs

Fields

NameDatatypeDescription
namestringThe name of the database.

Methods

NameAccessible byRequired ParamsDescription
databases_getSELECTdatabase_cluster_uuid, database_nameTo 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 Redis clusters. The response will be a JSON object with a db key. This will be set to an object containing the standard database attributes.
databases_listSELECTdatabase_cluster_uuidTo 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 array of database objects, each of which will contain the standard database attributes. Note: Database management is not supported for Redis clusters.
databases_addINSERTdatabase_cluster_uuid, data__nameTo 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 Redis clusters. The response will be a JSON object with a key called db. The value of this will be an object that contains the standard attributes associated with a database.
databases_deleteDELETEdatabase_cluster_uuid, database_nameTo 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 processed successfully, but that no response body is needed. Note: Database management is not supported for Redis clusters.

SELECT examples

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 array of database objects, each of which will contain the standard database attributes. Note: Database management is not supported for Redis clusters.

SELECT
name
FROM digitalocean.databases.dbs
WHERE database_cluster_uuid = '{{ database_cluster_uuid }}';

INSERT example

Use the following StackQL query and manifest file to create a new dbs resource.

/*+ create */
INSERT INTO digitalocean.databases.dbs (
data__name,
database_cluster_uuid
)
SELECT
'{{ name }}',
'{{ database_cluster_uuid }}'
;

DELETE example

Deletes the specified dbs resource.

/*+ delete */
DELETE FROM digitalocean.databases.dbs
WHERE database_cluster_uuid = '{{ database_cluster_uuid }}'
AND database_name = '{{ database_name }}';