Chapter 4. Backup Sources

You can configure multiple Backups in one configuration file. Each backup is represented by a <backup> Tag. To configure the data that is stored use the <source> Tag.

Table 4.1. Supported types of backup sources:

Type	Description
arangodump	Backup ArangoDB with the arangodump command line tool.
mongodump	Backup MongoDB with the mongodump command line tool.
mysqldump	Backup MySQL with the mysqldump command line tool.
redis	Backup redis with the redis-cli command line tool.
tar	Backup a directory with the tar command line tool.
xtrabackup	Backup MySQL with the percona xtrabackup command line tool.

ArangoDB

Backup a ArangoDB database with arangodump.

Table 4.2. arangodump-Options

Name	Value	Required	Default	Description
endpoint	string	no	tcp://localhost:8529	URI to your ArangoDB endpoint.
username	string	no	null	Username for the ArangoDB authentication.
password	string	no	null	Password for the ArangoDB authentication.
disableAuthentication	boolean	no	false	Disable the ArangoDB authentication.
database	string	no	_system	Database to backup.
dumpData	boolean	no	true	Dump database data.
includeSystemCollections	boolean	no	false	Dump system collections as well.
collections	string	no	all	List of collections to dump.
showStdErr	boolean	no	false	Show stdErr for debugging.

Example 4.1: arangodump XML example

<!-- source arangodump -->
<source type="arangodump">
  <option name="database" value="myDatabase" />
  <option name="dumpData" value="true" />
  <option name="collections" value="myCollection1,myCollection2" />
</source>

Example 4.2: arangodump JSON example

{
  "type": "arangodump",
  "options": {
    "database": "myDatabase",
    "dumpData": "true",
    "collections": "myCollection1,myCollection2"
  }
}

MongoDB

Backup a MongoDB database with mongodump.

Table 4.3. mongodump-Options

Name	Value	Required	Default	Description
host	string	no	localhost	Hostname of your MongoDB-Server.
user	string	no	OS-User	Username for the MongoDB authentication.
password	string	no	null	Password for the MongoDB authentication.
authenticationDatabase	string	no	null	MongoDB database that holds the user credentials.
databases	string	no	all	List of databases you want to backup, all by default.
excludeCollections	string	no	null	List of collections you don't want to backup.
excludeCollectionsWithPrefix	string	no	null	List of collection prefixes to exclude matching collections from backup.
showStdErr	boolean	no	false	Show stdErr for debugging.

Example 4.3: mongodump XML example

<!-- source mongodump -->
<source type="mongodump">
  <option name="databases" value="myDatabase"/>
  <option name="user" value="user.name"/>
  <option name="password" value="topsecret"/>
  <option name="excludeCollections" value="collectionFoo,collectionBar"/>
</source>

Example 4.4: mongodump JSON example

{
  "type": "mongodump",
  "options": {
    "databases": "myDatabase",
    "user": "user.name",
    "password": "topsecret",
    "excludeCollections": "collectionFoo,collectionBar"
  }
}

MySQL - mysqldump

Backup a MySQL database with mysqldump.

Table 4.4. mysqldump-Options

Name	Value	Required	Default	Description
host	string	no	localhost	Hostname of your MySQL-Server.
user	string	no	OS-User	Username for the MySQL authentication.
password	string	no	null	Password for the MySQL authentication.
databases	string	no	all	List of databases you want to backup, all by default.
ignoreTables	string	no	null	List of tables you don't want to backup.
structureOnly	string	no	null	List of tables where only the table structure will be stored.
hexBlob	true \| false	no	false	Use the --hex-blob option to dump blog fields in hex.
lockTables	true \| false	no	null	Use the --lock-tables option to lock tables during the dump.
extendedInsert	true \| false	no	false	Use multiple-row INSERT syntax. This results in a smaller dump file and speeds up inserts when the file is reloaded.
showStdErr	boolean	no	false	Show stdErr for debugging.

Example 4.5: mysqldump XML example

<!-- source mysqldump -->
<source type="mysqldump">
  <option name="databases" value="myDatabase"/>
  <option name="user" value="user.name"/>
  <option name="password" value="topsecret"/>
  <option name="ignoreTable" value="tableFoo,tableBar"/>
  <option name="structureOnly" value="logTable1,logTable2"/>
</source>

Example 4.6: mysqldump JSON example

{
  "type": "mysqldump",
  "options": {
    "databases": "myDatabase",
    "user": "user.name",
    "password": "topsecret",
    "ignoreTable": "tableFoo,tableBar",
    "structureOnly": "logTable1,logTable2"
  }
}

MySQL - xtrabackup

Backup a MySQL database with percona xtrabackup.

Table 4.5. xtrabackup-options

Name	Value	Required	Default	Description
dataDir	string	no		MySQL data directory.
host	string	no	localhost	Host to connect to.
user	string	no	OS-User	User to connect with.
password	string	no	false	Password to authenticate the user.
databases	string	no	-	List of databases to backup, all by default.
include	string	no	-	Pattern to include databases and tables to the backup e.g. `^mydatabase[.]mytable`.
showStdErr	boolean	no	false	Show stdErr for debugging.

Example 4.7: xtrabackup XML example

<!-- source xtrabackup -->
<source type="xtrabackup">
  <option name="databases" value="myDB1,myDB2" />
</source>

Example 4.8: xtrabackup JSON example

{
  "type": "xtrabackup",
  "options": {
    "databases": "myDB1,myDB2"
  }
}

redis

Backup redis data structure store using redis-cli.

Table 4.6. tar-Options

Name	Value	Required	Default	Description
pathToRedisData	string	yes	-	Path to the redis data .rdb file.
pathToRedisCli	string	no	-	Path to the redis-cli binary.
port	integer	no	6379	Port to use to connect to the redis server.
password	string	no	-	Password to use to authenticate.
showStdErr	boolean	no	false	Show stdErr for debugging.

Example 4.9: redis XML example

<!-- source redis -->
<source type="redis">
  <option name="pathToRedisData" value="/var/lib/redis/6379/dump.rdb"/>
</source>

Example 4.10: redis JSON example

{
  "type": "redis",
  "options": {
    "pathToRedisData": "/var/lib/redis/6379/dump.rdb"
  }
}

Directories

Backup directories using tar.

Table 4.7. tar-Options

Name	Value	Required	Default	Description
path	string	yes	-	Path to the source directory.
showStdErr	boolean	no	false	Show stdErr for debugging.

Example 4.11: tar XML example

<!-- source tar -->
<source type="tar">
  <option name="path" value="htdocs/uploads"/>
</source>

Example 4.12: tar JSON example

{
  "type": "tar",
  "options": {
    "path": "htdocs/uploads"
  }
}