Documentation Center

The loaddb tool

Generic operations on databases, such as backups, restores, data updates, etc. are carried out through the loaddb tool for the Legacy Content Delivery database. This tool also lets you carry out a list of more specific operations.

The loaddb tool is installed in the WEB-INF folder during the Legacy Content Delivery installation.

After the installation, you can access the tool by evoking a command line console from the WEB-INF repository in the file system (or use the absolute path to WEB-INF). Then type any loaddb command in the line of loaddb.bat <Options> <Command> (on Windows) or loaddb.sh <Options> <Command> (on Linux). For example, if on a Windows system you want to restore the backup named thisBackup that was locked with the password adminPass:
loaddb.bat -Dlc.file="thisBackup" -Dlc.pswd="adminPass" RESTORE
The main commands are BACKUP, RESTORE and UPGRADE.
  • BACKUP and RESTORE are typically used when the version of Legacy Content Delivery is upgraded, or as part of any operation on the database that could cause data losses. There is also a scheduled backup process that you can customize.
  • UPGRADE is typically used when working on skins. Skin files are changed in the file system, then they need to be loaded into the database before they can be used by Legacy Content Delivery . The UPGRADE command is used when anything new and changed needs to be loaded in the database.

The CHECKDB command may be used occasionally to verify the internal consistency of the database. It is also part of the scheduled backup, and can work in interaction with the BACKUP command.

There is a list of other commands that are much more specific, such as loadpub dedicated to db operations on publications and loadpac which is the command associated with all operations on packages. All the existing commands and command options are described in the loaddb reference.

The loaddb tool is easily accessed from the command line console. However, you can also use the eXist client to navigate inside the file system. The eXist client can be used whenever something prevents the loaddb tool to be used from the command line console.