replicas

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

Overview

Name	replicas
Type	Resource
Id	digitalocean.databases.replicas

Fields

Name	Datatype	Description
id	string	A unique ID that can be used to identify and reference a database replica.
name	string	The name to give the read-only replicating
connection	object
created_at	string	A time value given in ISO8601 combined date and time format that represents when the database cluster was created.
private_connection	object
private_network_uuid	string	A string specifying the UUID of the VPC to which the read-only replica will be assigned. If excluded, the replica will be assigned to your account's default VPC for the region.
region	string	A slug identifier for the region where the read-only replica will be located. If excluded, the replica will be placed in the same region as the cluster.
size	string	A slug identifier representing the size of the node for the read-only replica. The size of the replica must be at least as large as the node size for the database cluster from which it is replicating.
status	string	A string representing the current status of the database cluster.
storage_size_mib	integer	Additional storage added to the cluster, in MiB. If null, no additional storage is added to the cluster, beyond what is provided as a base amount from the 'size' and any previously added additional storage.
tags	array	A flat array of tag names as strings to apply to the read-only replica after it is created. Tag names can either be existing or new tags.

Methods

Name	Accessible by	Required Params	Description
databases_get_replica	SELECT	database_cluster_uuid, replica_name	To show information about an existing database replica, send a GET request to /v2/databases/$DATABASE_ID/replicas/$REPLICA_NAME. Note: Read-only replicas are not supported for Redis clusters. The response will be a JSON object with a replica key. This will be set to an object containing the standard database replica attributes.
databases_list_replicas	SELECT	database_cluster_uuid	To list all of the read-only replicas associated with a database cluster, send a GET request to /v2/databases/$DATABASE_ID/replicas. Note: Read-only replicas are not supported for Redis clusters. The result will be a JSON object with a replicas key. This will be set to an array of database replica objects, each of which will contain the standard database replica attributes.
databases_create_replica	INSERT	database_cluster_uuid, data__name	To create a read-only replica for a PostgreSQL or MySQL database cluster, send a POST request to /v2/databases/$DATABASE_ID/replicas specifying the name it should be given, the size of the node to be used, and the region where it will be located. Note: Read-only replicas are not supported for Redis clusters. The response will be a JSON object with a key called replica. The value of this will be an object that contains the standard attributes associated with a database replica. The initial value of the read-only replica's status attribute will be forking. When the replica is ready to receive traffic, this will transition to active.
databases_destroy_replica	DELETE	database_cluster_uuid, replica_name	To destroy a specific read-only replica, send a DELETE request to /v2/databases/$DATABASE_ID/replicas/$REPLICA_NAME. Note: Read-only replicas are not supported for Redis clusters. A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed.
databases_promote_replica	EXEC	database_cluster_uuid, replica_name	To promote a specific read-only replica, send a PUT request to /v2/databases/$DATABASE_ID/replicas/$REPLICA_NAME/promote. Note: Read-only replicas are not supported for Redis clusters. A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed.

SELECT examples

To list all of the read-only replicas associated with a database cluster, send a GET request to /v2/databases/$DATABASE_ID/replicas. Note: Read-only replicas are not supported for Redis clusters. The result will be a JSON object with a replicas key. This will be set to an array of database replica objects, each of which will contain the standard database replica attributes.

SELECT
id,
name,
connection,
created_at,
private_connection,
private_network_uuid,
region,
size,
status,
storage_size_mib,
tags
FROM digitalocean.databases.replicas
WHERE database_cluster_uuid = '{{ database_cluster_uuid }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO digitalocean.databases.replicas (
data__name,
data__region,
data__size,
data__tags,
data__private_network_uuid,
data__storage_size_mib,
database_cluster_uuid
)
SELECT 
'{{ name }}',
'{{ region }}',
'{{ size }}',
'{{ tags }}',
'{{ private_network_uuid }}',
'{{ storage_size_mib }}',
'{{ database_cluster_uuid }}'
;

All Properties

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

Manifest

- name: replicas
  props:
    - name: database_cluster_uuid
      value: string
    - name: data__name
      value: string
    - name: name
      value: string
    - name: region
      value: string
    - name: size
      value: string
    - name: tags
      value: array
    - name: private_network_uuid
      value: string
    - name: storage_size_mib
      value: integer

DELETE example

Deletes the specified replicas resource.

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