db_restore

This job restores the given database from the given backup. The backup must meet certain prerequisites defined in documentation, such as originating from a database with the same number of nodes. The database must be offline to perform a restore.

Mandatory Parameters

Parameter Name Data Type Description
db_name string Name of an existing database to be restored.
backup_id string ID of an existing backup. A backup ID has the format "<volume_id> <path_to_backup> <db_name>", for example "1 exa_db/id_1/level_0/node_0/backup_201811061154 exa_db". This can be obtained from the return value of the job db_backup_list, under the key ID.
restore_type string Type of restore. The value must be either 'blocking', 'nonblocking', or 'virtual access'.

Optional Parameters

There are no optional parameters.

Substitute Parameters

There are no substitute parameters.

Allowed Users

The following users are allowed to run this job:

  • root

Allowed Groups

The following groups are allowed to run this job:

  • root
  • exaadm
  • exadbadm

Examples

The following code snippets show how to use this job using both Python (via XML-RPC) and on the command-line using confd_client.

conn.job_exec('db_restore', {'params': {'db_name': 'exa_db', 'backup_id': '1 exa_db/id_1/level_0/node_0/backup_201811131114 exa_db', 'restore_type': 'blocking'}})
confd_client db_restore db_name: exa_db backup_id: '1 exa_db/id_1/level_0/node_0/backup_201811131114 exa_db' restore_type: blocking