databases

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

Overview

Name	databases
Type	Resource
Id	ovh.hosting_private_database.databases

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
database_name	string	Database name (wire: databaseName)
backup_time	string (time)	Time of the next backup (every day) (example: 15:04:05) (wire: backupTime)
creation_date	string (date-time)	Creation date of the database (wire: creationDate)
quota_used	object	Space used by the database (wire: quotaUsed)
users	array	Users granted to this database

list

Databases

Name	Datatype	Description
database_name	string	Database name (wire: databaseName)
backup_time	string (time)	Time of the next backup (every day) (example: 15:04:05) (wire: backupTime)
creation_date	string (date-time)	Creation date of the database (wire: creationDate)
quota_used	object	Space used by the database (wire: quotaUsed)
users	array	Users granted to this database

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	database_name, service_name		Returns the size and creation date of the database, its daily backup time and the users granted on it.
list	select	service_name	x_pagination_mode	Returns the names of the databases of the service.
create	insert	service_name, database_name		Creates an empty database on the service and returns a task to follow the creation. To also create a user with access to it, use the database wizard.
delete	delete	database_name, service_name		Deletes the database and returns a task to follow the deletion. Its dumps are kept as orphan dumps.
copy_restore	exec	databaseName, serviceName, copyId		Restores a copy into the database. The database is not flushed before the restore unless requested.
import	exec	databaseName, serviceName, documentId		Imports a dump file stored in /me/document into the database. The database is not flushed before the import unless requested.

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)
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 size and creation date of the database, its daily backup time and the users granted on it.

SELECT
database_name,
backup_time,
creation_date,
quota_used,
users
FROM ovh.hosting_private_database.databases
WHERE database_name = '{{ database_name }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

Returns the names of the databases of the service.

SELECT
database_name,
backup_time,
creation_date,
quota_used,
users
FROM ovh.hosting_private_database.databases
WHERE service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Creates an empty database on the service and returns a task to follow the creation. To also create a user with access to it, use the database wizard.

INSERT INTO ovh.hosting_private_database.databases (
database_name,
service_name
)
SELECT 
'{{ database_name }}' /* required */,
'{{ 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: databases
props:
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the databases resource.
  - name: database_name
    value: "{{ database_name }}"
    description: |
      Name of your new database

DELETE examples

delete

Deletes the database and returns a task to follow the deletion. Its dumps are kept as orphan dumps.

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

Lifecycle Methods

EXEC variables use wire (API) names.

copy_restore

Restores a copy into the database. The database is not flushed before the restore unless requested.

EXEC ovh.hosting_private_database.databases.copy_restore 
@databaseName='{{ databaseName }}' --required, 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"copyId": "{{ copyId }}", 
"flushDatabase": {{ flushDatabase }}
}'
;

import

Imports a dump file stored in /me/document into the database. The database is not flushed before the import unless requested.

EXEC ovh.hosting_private_database.databases.import 
@databaseName='{{ databaseName }}' --required, 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"documentId": "{{ documentId }}", 
"flushDatabase": {{ flushDatabase }}, 
"sendEmail": {{ sendEmail }}
}'
;