database_dumps

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

Overview

Name	database_dumps
Type	Resource
Id	ovh.hosting_private_database.database_dumps

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer	Dump id
database_name	string	Dump of this database name (wire: databaseName)
creation_date	string (date-time)	Creation date of the dump (wire: creationDate)
deletion_date	string (date-time)	Automatic deletion date of the dump (wire: deletionDate)
url	string	Dump URL access

list

Dumps

Name	Datatype	Description
id	integer	Dump id
database_name	string	Dump of this database name (wire: databaseName)
creation_date	string (date-time)	Creation date of the dump (wire: creationDate)
deletion_date	string (date-time)	Automatic deletion date of the dump (wire: deletionDate)
url	string	Dump URL access

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	database_name, id, service_name		Returns the creation date, automatic deletion date and download URL of the dump.
list	select	database_name, service_name	x_pagination_mode	Returns the IDs of the dumps of the database. To include dumps of deleted databases, list the dumps of the service.
create	insert	database_name, service_name		Creates a dump of the database and returns a task to follow it. The download link is valid for 30 days and is sent by email only when requested.
delete	delete	database_name, id, service_name		Deletes the dump before its automatic deletion date.
restore	exec	databaseName, id, serviceName		Restores the dump into the database it was taken from. By default, the database is flushed before the restore.

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"}})
databaseName	string	Database name
database_name	string	Database name (wire: databaseName)
id	integer	Id
serviceName	string	Service name
service_name	string	Service name (wire: serviceName)
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

Returns the creation date, automatic deletion date and download URL of the dump.

SELECT
id,
database_name,
creation_date,
deletion_date,
url
FROM ovh.hosting_private_database.database_dumps
WHERE database_name = '{{ database_name }}' -- required
AND id = '{{ id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

Returns the IDs of the dumps of the database. To include dumps of deleted databases, list the dumps of the service.

SELECT
id,
database_name,
creation_date,
deletion_date,
url
FROM ovh.hosting_private_database.database_dumps
WHERE database_name = '{{ database_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Creates a dump of the database and returns a task to follow it. The download link is valid for 30 days and is sent by email only when requested.

INSERT INTO ovh.hosting_private_database.database_dumps (
send_email,
database_name,
service_name
)
SELECT 
{{ send_email }},
'{{ database_name }}',
'{{ service_name }}'
RETURNING
id,
dump_id,
database_name,
user_name,
done_date,
function,
last_update,
start_date,
status
;

Manifest

# Description fields are for documentation purposes
- name: database_dumps
props:
  - name: database_name
    value: "{{ database_name }}"
    description: Required parameter for the database_dumps resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the database_dumps resource.
  - name: send_email
    value: {{ send_email }}
    description: |
      Whether to receive an email when the import is complete (default to false)

DELETE examples

delete

Deletes the dump before its automatic deletion date.

DELETE FROM ovh.hosting_private_database.database_dumps
WHERE database_name = '{{ database_name }}' --required
AND id = '{{ id }}' --required
AND service_name = '{{ service_name }}' --required
;

Lifecycle Methods

EXEC variables use wire (API) names.

restore

Restores the dump into the database it was taken from. By default, the database is flushed before the restore.

EXEC ovh.hosting_private_database.database_dumps.restore 
@databaseName='{{ databaseName }}' --required, 
@id='{{ id }}' --required, 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"flushDatabase": {{ flushDatabase }}
}'
;