Skip to main content

cluster_config

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

Overview

Namecluster_config
TypeResource
Iddigitalocean.databases.cluster_config

Fields

The following fields are returned by SELECT queries:

A JSON object with a key of config.

NameDatatypeDescription
config

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
databases_get_configselectdatabase_cluster_uuidShows 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 object
containing any database configuration parameters.
databases_patch_configupdatedatabase_cluster_uuidTo update the configuration for an existing database cluster, send a PATCH request to
/v2/databases/$DATABASE_ID/config.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
database_cluster_uuidstring (uuid)A unique identifier for a database cluster. (example: 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30)

SELECT examples

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 object
containing any database configuration parameters.

SELECT
config
FROM digitalocean.databases.cluster_config
WHERE database_cluster_uuid = '{{ database_cluster_uuid }}' -- required;

UPDATE examples

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

UPDATE digitalocean.databases.cluster_config
SET
data__config = '{{ config }}'
WHERE
database_cluster_uuid = '{{ database_cluster_uuid }}' --required;