---
name: "myrocks_hotbackup"
section: "1"
platform: "linux"
package: "mariadb"
version: "13.0.2-2"
release: "Arch Linux 2026-11-01"
platforms: ["linux"]
url: "https://new.carta.tech/myrocks_hotbackup"
---

# myrocks\_hotbackup(1)

streaming backup for MariaDB MyRocks

## NAME

myrocks\_hotbackup - streaming backup for MariaDB MyRocks

## DESCRIPTION

Usage:

Backup: set **-o** pipefail; myrocks\_hotbackup **--user**=*root* **--password**=*pw* **--port**=*3306* **--checkpoint\_dir=**\<directory where temporary backup hard links are created\> \| ssh **-o** NoneEnabled=yes remote\_server 'tar **-xi** **-C** \<directory on remote server where backups will be sent\>' . You need to execute backup command on a server where you take backups.

Backup using WDT: myrocks\_hotbackup **--user**=*root* **--password**=*pw* **--stream**=*wdt* **--checkpoint\_dir=**\<directory where temporary backup hard links are created\> **--destination=**\<remote host name\> **--backup\_dir=**\<remote directory name\>. This has to be executed at the src host.

Move-Back: myrocks\_hotbackup **--move\_back** **--datadir=**\<dest mysql datadir\> **--rocksdb\_datadir=**\<dest rocksdb datadir\> **--rocksdb\_waldir=**\<dest rocksdb wal dir\> **--backup\_dir=**\<where backup files are stored\> . You need to execute move-back command on a server where backup files are sent.

## OPTIONS

- **-h**, **--help**

  show this help message and exit

- **-i** CHECKPOINT\_INTERVAL, **--interval**=*CHECKPOINT\_INTERVAL*

  Number of seconds to renew checkpoint

- **-c** CHECKPOINT\_DIRECTORY, **--checkpoint\_dir**=*CHECKPOINT\_DIRECTORY*

  Local directory name where checkpoints will be created.

- **-d** DATADIR, **--datadir**=*DATADIR*

  backup mode: src MySQL datadir. move\_back mode: dest MySQL datadir

- **-s** OUTPUT\_STREAM, **--stream**=*OUTPUT\_STREAM*

  Setting streaming backup options. Currently tar, WDT and xbstream are supported. Default is tar

- **--destination**=*DESTINATION*

  Remote server name. Only used for WDT mode so far.

- **--avg\_mbytes\_per\_sec**=*AVG\_MBYTES\_PER\_SEC*

  Average backup rate in MBytes/sec. WDT only.

- **--extra\_wdt\_sender\_options**=*EXTRA\_WDT\_SENDER\_OPTIONS*

  Extra options for WDT sender

- **--extra\_wdt\_receiver\_options**=*EXTRA\_WDT\_RECEIVER\_OPTIONS*

  Extra options for WDT receiver

- **-u** MYSQL\_USER, **--user**=*MYSQL\_USER*

  MySQL user name

- **-p** MYSQL\_PASSWORD, **--password**=*MYSQL\_PASSWORD*

  MySQL password name

- **-P** MYSQL\_PORT, **--port**=*MYSQL\_PORT*

  MySQL port number

- **-S** MYSQL\_SOCKET, **--socket**=*MYSQL\_SOCKET*

  MySQL socket path. Takes precedence over **--port**.

- **-m**, **--move\_back**

  Moving MyRocks backup files to proper locations.

- **-r** ROCKSDB\_DATADIR, **--rocksdb\_datadir**=*ROCKSDB\_DATADIR*

  RocksDB target data directory where backup data files will be moved. Must be empty.

- **-w** ROCKSDB\_WALDIR, **--rocksdb\_waldir**=*ROCKSDB\_WALDIR*

  RocksDB target data directory where backup wal files will be moved. Must be empty.

- **-b** BACKUPDIR, **--backup\_dir**=*BACKUPDIR*

  backup mode for WDT: Remote directory to store backup. move\_back mode: Locations where backup files are stored.

- **-f**, **--skip\_check\_frm\_timestamp**

  skipping to check if frm files are updated after starting backup.

- **-D** DEBUG\_SIGNAL\_FILE, **--debug\_signal\_file**=*DEBUG\_SIGNAL\_FILE*

  debugging purpose: waiting until the specified file is created

## SEE ALSO

For more information, please refer to the MariaDB Documentation, available online at https://mariadb.com/docs

## AUTHOR

MariaDB Foundation (http://www.mariadb.org/).