clickhouse_backups

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

Overview

Name	clickhouse_backups
Type	Resource
Id	ovh.cloud_database.clickhouse_backups

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string (uuid)	Backup ID
created_at	string (date-time)	Date of the creation of the backup (wire: createdAt)
description	string	Description of the backup
region	string	Region where the backup is stored. DEPRECATED: use regions
regions	array	Regions where the backup are stored
size	object	Size of the backup
status	string	Current status of the backup (CREATING, DELETING, DRAINED, ERROR, LOCKED, LOCKED_PENDING, LOCKED_UPDATING, PENDING, READY, SHELVED, TO_DRAIN, UPDATING)
type	string	Type of backup (automatic, manual, none, pitr, snapshot)

list

Cloud database backup definition

Name	Datatype	Description
id	string (uuid)	Backup ID
created_at	string (date-time)	Date of the creation of the backup (wire: createdAt)
description	string	Description of the backup
region	string	Region where the backup is stored. DEPRECATED: use regions
regions	array	Regions where the backup are stored
size	object	Size of the backup
status	string	Current status of the backup (CREATING, DELETING, DRAINED, ERROR, LOCKED, LOCKED_PENDING, LOCKED_UPDATING, PENDING, READY, SHELVED, TO_DRAIN, UPDATING)
type	string	Type of backup (automatic, manual, none, pitr, snapshot)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	backup_id, cluster_id, service_name		Get clickhouse backups
list	select	cluster_id, service_name	x_pagination_mode	List backups of the clickhouse

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.

Name	Datatype	Description
api_host	string	The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
backup_id	string (uuid)	Backup ID (wire: backupId)
cluster_id	string (uuid)	Cluster ID (wire: clusterId)
service_name	string	The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.
x_pagination_mode	string	Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode)

SELECT examples

get

Get clickhouse backups

SELECT
id,
created_at,
description,
region,
regions,
size,
status,
type
FROM ovh.cloud_database.clickhouse_backups
WHERE backup_id = '{{ backup_id }}' -- required
AND cluster_id = '{{ cluster_id }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

list

List backups of the clickhouse

SELECT
id,
created_at,
description,
region,
regions,
size,
status,
type
FROM ovh.cloud_database.clickhouse_backups
WHERE cluster_id = '{{ cluster_id }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
AND x_pagination_mode = '{{ x_pagination_mode }}'
;