Server backups are stored as increment of same backup name under a particular backup path (could be modified via SDK). Valid backup status are:
Code | Description | Corresponding progress message |
|---|---|---|
| unknown | Un-initialied, initialized or unknow error | |
| creating | Creating | The graphset being backed up |
| failed | Failed | Errors that lead to failure |
| done | Done | 'ok' |
NOTEOperations related to server backup will be sent to the leader of the server cluster.
Server backups are named by developers. A same name cannot be shared between backups under the same backup path.
Returned table name: the backup name, one table for each backup
Returned table header: backup_id | backup_uuid | backup_path | start_time | end_time | status | msg (the id, uuid, path, start time, end time, status and prgress message of the backup increment)
Syntax:
Syntax// To show all backups in the current Ultipa instance db.backup.show() // To show a certain backup in the current Ultipa instance db.backup.show("<backup_name>")
When creating a backup whose name already exists in the current backup path, a backup increment will be created, with unique backup_id and backup_uuid.
Syntax:
Syntax// To create a backup in the current Ultipa instance db.backup.create("<backup_name>")
Backup name is required when restoring the Ultipa instance, while the backup_id of increment is optional.
Syntax:
Syntax// To restore current Ultipa instance to the latest increment of a certain backup db.backup.restore("<backup_name>") // To restore current Ultipa instance to a certain increment of a certain backup db.backup.restore("<backup_name>", backup_id)
