Restore from Backup
Database backups are stored in archive volumes, which can be on either local or remote servers. In case of a database instance failure, unsuccessful updates, or errors on your database, it can be restored to the previous state using these backups.
The database must be shut down to restore from a backup. For more information, see Stop a Database.
You must have an archive volume that contains the backup that you want to restore. For more information, see Create Remote Archive Volume with Amazon S3 .
The database to which you are restoring the backup must have the same number of active nodes as the one used to create the backup.
The version of the database to which you are restoring must be based on the same LTS version as the backup version. For example, the backed up database is Exasol 8.16 and the new database that you are restoring to is Exasol 8.20. For more information, see Product Life Cycle.
If you want to restore a backup of an Exasol 7.1 database to an Exasol 8 database, see Migrate from Exasol 7.1 to Exasol 8.
This procedure can be carried out using the RESTful Administration API. For more information, see Administration API.
The examples in this procedure are written using Bash on a Linux terminal. You can also use other interfaces and languages to execute the commands.
Placeholder values are styled as Bash variables, starting with the dollar sign ($) and using UPPERCASE characters. Replace the placeholders with your own values before executing the curl command.
Get information about the database by sending a
GETrequest to the
/api/v1/databasesendpoint. For example:
curl -k -X "GET" \
-H "accept: application/json" \
-H "Authorization: Basic $AUTH_TOKEN"
The response will include the following:
Number of clusters in the database
Number of clusters running
Additional database parameters and hardware details may be included in the response depending on the configuration and platform.
Determine the ID of the backup to restore.
How to determine the ID for a backup depends on whether you are restoring the backup to the same database that the backup was taken on, or to a different database. In the latter case, the backup is said to have been taken on a foreign database.
List backups from the same database:
To get information about all existing backups for the current database, send a
/api/v1/databases/DATABASE_ID/backups. For example:
curl -k -X 'GET' \
-H 'accept: application/json' \
-H 'Authorization: Basic $TOKEN'
List backups from all databases:
Backups taken on foreign databases cannot be listed using the Administration API. In this case you must use the ConfD job db_backup_list with the
show_foreignparameter set to
Example of backup ID:
A backup ID has the structure VOLUME_ID BACKUP_NAME BACKUP_DATABASE_NAME.
VOLUME_ID is the ID of the archive volume containing the backup.
BACKUP_NAME is the path and name of the backup file, consisting of the following parameters:
BACKUP_DATABASE_NAME is the name of the database that was backed up.
To restore a backup, send a
PUTrequest to the
/api/v1/databases/DATABASE_ID/backups/restoreendpoint, and include the backup ID and restore type for the backup in the request. For example:
When the backup has been successfully restored, the database will automatically restart.
To verify the database has been restored, connect to the database and view the latest entries in EXA_SYSTEM_EVENTS:
You should see entries with
RESTORE_END similar to the following: