Database Backup Utility (backup-data)

Edit online

The backup utility creates a backup of the data being shared by your application by taking a snapshot of the data held by the Terracotta Server Array (TSA). Unless a different directory is specified in configuration, backups are saved to the default directory ${user.dir}/terracotta/backups.

Configuring Backup

You can override this default behavior by specifying a different backup directory in the server's configuration file using the <data-backup> property: 

<servers> 
   <restartable enabled="true"/> 
... 
   <server host="%i" name="myServer"> 
   ... 
     <data-backup>/Users/myBackups</data-backup> 
   </server> 
... 
</servers>

Note that enabling <restartable> mode is required for using the backup utility.

Creating a Backup

The backup utility relies on the Terracotta Management Server (TMS) to locate and execute backups. The TMS must be running and connected to the TSA for the backup to take place. For more information about connecting the Terracotta Management Server to the TSA, see the Terracotta Management Console User Guide.

For Microsoft Windows: 

[PROMPT] %BIGMEMORY_HOME%\tools\management-console\bin\backup-data.bat <args>

For UNIX/Linux: 

[PROMPT] ${BIGMEMORY_HOME}/tools/management-console/bin/backup-data.sh <args>

where <args> are:

  • [l] <tms-host:port> – The host and port used to connect to the TMS. If omitted, http://localhost:9889 is used by default.
  • [u] <username> – If the TMS requires authentication, a username must be specified.
  • [p] <password> – If the TMS requires authentication, a password must be specified.
  • [a] <agentID> – Specify the agent ID of a TSA. The agent ID is set as a connection name when the connection to the TSA is configured on the TMS. If no agent ID is provided, the TMS returns a list of configured agent IDs.
  • [k] This flag causes invalid TMS SSL certificates to be ignored.

For example, to initiate a backup on a cluster with the agent ID "someConnection": 

${BIGMEMORY_HOME}/tools/management-console/bin/ 
backup-data.sh -l http://my-tms-host:9889 \ -u admin 
-p admin -a someConnection -k

If initiation is successful, the script reports that the backup process has started. Once the backup is complete, the backup data files can be used to restore data in place of the current data files. For information about restoring data from a backup, see Restoring Data from a Backup.