System Administration - eXist: A NoSQL Database and Application Development Platform - page 398

Restoring a backup with the Java Admin Client is even simpler: you just need to open
the Restore Backup dialog by clicking the Restore icon or choosing the
Tools→Restore menu item, and then selecting the previous backup that you created.

Command-line backup
Command-line scripts for performing a client-side data export backup (and restore)
of the database are provided with eXist in the form of the $EXIST_HOME/bin/
backup.sh file (for Unix, Linux, and Mac platforms) and $EXIST_HOME/bin/
backup.bat file (for Windows platforms). These scripts take several arguments, which
are demonstrated in Example 15-1 and explained in Table 15-3 .

Example 15-1. Backing up the entire database (in ZIP format) from the command line

$EXIST_HOME /bin/backup.sh --user admin --password some-password --backup /db
--destination /export/backups/exist-db.201312271159.zip

Table 15-3. Command-line backup arguments

Argument Description Mandatory/optional

-u or --user

The username for connecting to the database. Typically, must be a
dba user when performing a backup.

Mandatory, but if
omitted, the default
username admin is
used

-p or --password

The password for the user connecting to the database. Mandatory, unless the

user does not have a
password

-b or --backup

The collection hierarchy to back up (e.g., /db ). Mandatory

-d or --
destination

The destination for the backup. Either a folder path, or a filename
ending with .zip to create a ZIP file backup.

Mandatory

-o or --option

Any additional options for the backup client that are needed to
connect to the eXist server. For example, if using SSL: -ossl-
enable=true
-ouri=xmldb:exist://local
host:8443/exist/xmlrpc .

Optional

When you're restoring a backup from the command line, the same scripts take
slightly different arguments, as you can see in Example 15-2 and Table 15-4 .

Example 15-2. Restoring a database backup (in ZIP format) from the command line

$EXIST_HOME /bin/backup.sh --user admin --password some-password
--restore /export/backups/exist-db.201312271159.zip