| Option | --backup-directory | |
| Aliases | --repl-backup-directory | |
| Config File Options | backup-directory, repl-backup-directory | |
| Description | Permanent backup storage directory | |
| Value Type | string | |
| Default | {home directory}/backups | |
| Option | --backup-dump-directory | |
| Aliases | --repl-backup-dump-directory | |
| Config File Options | backup-dump-directory, repl-backup-dump-directory | |
| Description | Backup temporary dump directory | |
| Value Type | string | |
| Option | --backup-method | |
| Aliases | --repl-backup-method | |
| Config File Options | backup-method, repl-backup-method | |
| Description | Database backup method | |
| Value Type | string | |
| Valid Values | ebs-snapshot | |
| file-copy-snapshot | ||
| mariabackup | Use mariabackup (Available from v7.0.0 only) | |
| mariabackup-incremental | Use mariabackup (Available from v7.0.0 only) | |
| mysqldump | Use mysqldump | |
| none | ||
| script | Use a custom script | |
| xtrabackup | Use Percona XtraBackup | |
| xtrabackup-full | Use Percona XtraBackup Full | |
| xtrabackup-incremental | Use Percona XtraBackup Incremental | |
The default, if not supplied, will be dependant on the enviroment. During installation tpm will detect which tools are available, favouring xtrabackup-full (or mariabackup-full). If not found, then mysqldump will be the default.
| Option | --backup-online | |
| Aliases | --repl-backup-online | |
| Config File Options | backup-online, repl-backup-online | |
| Description | Does the backup script support backing up a datasource while it is ONLINE | |
| Value Type | boolean | |
| Valid Values | false | |
| true | ||
| Option | --backup-options | |
| Config File Options | backup-options | |
| Description | Space separated list of options to pass directly to the underlying backup binary in use. | |
| Value Type | string | |
| Option | --backup-retention | |
| Aliases | --repl-backup-retention | |
| Config File Options | backup-retention, repl-backup-retention | |
| Description | Number of backups to retain | |
| Value Type | numeric | |
| Option | --backup-script | |
| Aliases | --repl-backup-script | |
| Config File Options | backup-script, repl-backup-script | |
| Description | What is the path to the backup script | |
| Value Type | filename | |
| Option | --batch-enabled | |
| Config File Options | batch-enabled | |
| Description | Should the replicator service use a batch applier | |
| Value Type | boolean | |
| Default | false | |
| Valid Values | true | |
| Option | --batch-load-language | |
| Config File Options | batch-load-language | |
| Description | Which script language to use for batch loading | |
| Value Type | string | |
| Valid Values | js | JavaScript |
| sql | SQL | |
| Option | --batch-load-template | |
| Config File Options | batch-load-template | |
| Description | Value for the loadBatchTemplate property | |
| Value Type | string | |
| Option | --repl-buffer-size | |
| Config File Options | repl-buffer-size | |
| Description | Replicator queue size between stages (min 1) | |
| Value Type | numeric | |
| Default | 10 | |