MYROCKS\_HOTBACKUP(1) MariaDB Database System MYROCKS\_HOTBACKUP(1)

# [NAME](#NAME)

myrocks\_hotbackup - streaming backup for MariaDB MyRocks

# [DESCRIPTION](#DESCRIPTION)

Usage:

Backup: set **-o** pipefail; myrocks\_hotbackup **--user**=*root* **--password**=*pw* **--port**=*3306* **--checkpoint\_dir=**&lt;directory where temporary backup hard links are created&gt; | ssh **-o** NoneEnabled=yes remote\_server 'tar **-xi** **-C** &lt;directory on remote server where backups will be sent&gt;' . 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=**&lt;directory where temporary backup hard links are created&gt; **--destination=**&lt;remote host name&gt; **--backup\_dir=**&lt;remote directory name&gt;. This has to be executed at the src host.

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

# [OPTIONS](#OPTIONS)

[**-h**, **--help**](#h)

show this help message and exit

[**-i** CHECKPOINT\_INTERVAL, **--interval**=*CHECKPOINT\_INTERVAL*](#i)

Number of seconds to renew checkpoint

[**-c** CHECKPOINT\_DIRECTORY, **--checkpoint\_dir**=*CHECKPOINT\_DIRECTORY*](#c)

Local directory name where checkpoints will be created.

[**-d** DATADIR, **--datadir**=*DATADIR*](#d)

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

[**-s** OUTPUT\_STREAM, **--stream**=*OUTPUT\_STREAM*](#s)

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

[**--destination**=*DESTINATION*](#destination)

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

[**--avg\_mbytes\_per\_sec**=*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_wdt_sender_options)

Extra options for WDT sender

[**--extra\_wdt\_receiver\_options**=*EXTRA\_WDT\_RECEIVER\_OPTIONS*](#extra_wdt_receiver_options)

Extra options for WDT receiver

[**-u** MYSQL\_USER, **--user**=*MYSQL\_USER*](#u)

MySQL user name

[**-p** MYSQL\_PASSWORD, **--password**=*MYSQL\_PASSWORD*](#p)

MySQL password name

[**-P** MYSQL\_PORT, **--port**=*MYSQL\_PORT*](#P)

MySQL port number

[**-S** MYSQL\_SOCKET, **--socket**=*MYSQL\_SOCKET*](#S)

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

[**-m**, **--move\_back**](#m)

Moving MyRocks backup files to proper locations.

[**-r** ROCKSDB\_DATADIR, **--rocksdb\_datadir**=*ROCKSDB\_DATADIR*](#r)

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

[**-w** ROCKSDB\_WALDIR, **--rocksdb\_waldir**=*ROCKSDB\_WALDIR*](#w)

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

[**-b** BACKUPDIR, **--backup\_dir**=*BACKUPDIR*](#b)

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

[**-f**, **--skip\_check\_frm\_timestamp**](#f)

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

[**-D** DEBUG\_SIGNAL\_FILE, **--debug\_signal\_file**=*DEBUG\_SIGNAL\_FILE*](#D)

debugging purpose: waiting until the specified file is created

# [SEE ALSO](#SEE_ALSO)

For more information, please refer to the MariaDB Knowledge Base, available online at https://mariadb.com/kb/

# [AUTHOR](#AUTHOR)

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

15 May 2020 MariaDB 10.6

---

Document: myrocks_hotbackup(1) from mariadb-10.6 10.6.12-r1 (Chainguard OS)
Source: https://github.com/MariaDB/server.git
