Derby Database Backup and Restore

Owned by Kevin Wu
Last updated: Jun 15, 2023
1 min read

To produce a full online backup of the Platform databases when running Derby, use the following  mzsh  command:

$ mzsh mzadmin/<password> derbybackup <backup directory>



To restore the database:

  1. Shut down .

      

  2. Move all directories and files from the backup directory to the Derby restore directory. Use the following command to retrieve the restore directory:

    mzsh topo get --format data-only topo://services:standard/val:storage-dispatcher.storage-dispatcher1.config.db-properties.derby.restore.path

     

  3. Startup .

After a restore has been performed, the directory defined in  derby.restore.path  will be renamed upon the next startup, in order to prevent another restore from being made. The new name consists of the old name with the _USED suffix attached. The startup procedure also creates an entry in the System Log, showing the outcome of the restore.

Hint!

One way of performing regular backups is to create a script that runs the  derbybackup  command and includes a date as part of the directory name. The script may be called at a regular interval, for instance, once a day, by adding and scheduling a script executor in a  Task Workflow  in the  Workflow Editor .

Â