Backup/Restore of your Data Virtuality Configuration

The Data Virtuality configuration database holds all important data about your system, such as your data model, data sources, jobs and users. In order to be able to restore your configuration as part of a disaster recovery, you should frequently backup your Data Virtuality installation.  

What can be backed up?

You can backup your data source definitions, virtual schemas, optimizations, job definitions, users and roles and their permissions.

Manual backup

In order to backup your Data Virtuality configuration manually via the Studio, use the File/Export menu item. In the following dialog, choose the items to export.

Choose Next.

Your configuration will be exported as SQL. Choose to save to file.

Automated backup

As part of an automated backup, you can also generate exports programmatically. Navigate to the folder bin/cli-export-1.0 inside your Data Virtuality installation directory (/opt/datavirtuality/dvserver on Linux, C:\Program Files\Data Virtuality Suite\DVServer on Windows) and execute the file export.sh/.bat:

Linux

./export.sh --host localhost --username admin --password admin --file /home/user/backups/export-`date "+%Y%m%d-%H%M%S"`.sql

Windows

export.bat --host localhost --username admin --password admin --file "C:\Users\User name\Backups\export-%time:~0,2%%time:~3,2%%time:~6,2%_%date:~-10,2%%date:~-7,2%%date:~-4,4%.sql"

This command can be scheduled to run periodically, e.g. as a cronjob) to dump the configuration into an SQL file at the specified path.

We recommend storing your backups on a different server, a network drive or S3 bucket to not lose them in case your server hosting the Data Virtuality instance gets corrupted.

Restoring your configuration

Open a new SQL tab in the Data Virtuality Studio by pressing the SQL button. Paste the contents of the exported configuration into the tab.

It is very important to review the configuration before you run the script.

Execute the SQL. Refresh the items you restored in the Data Virtuality Studio.