1MYROCKS_HOTBACKUP(1) MariaDB Database System MYROCKS_HOTBACKUP(1)
2
3
4
6 myrocks_hotbackup - streaming backup for MariaDB MyRocks
7
9 Usage:
10
11 Backup: set -o pipefail; myrocks_hotbackup --user=root --password=pw
12 --port=3306 --checkpoint_dir=<directory where temporary backup hard
13 links are created> | ssh -o NoneEnabled=yes remote_server 'tar -xi -C
14 <directory on remote server where backups will be sent>' . You need to
15 execute backup command on a server where you take backups.
16
17 Backup using WDT: myrocks_hotbackup --user=root --password=pw
18 --stream=wdt --checkpoint_dir=<directory where temporary backup hard
19 links are created> --destination=<remote host name> --backup_dir=<re‐
20 mote directory name>. This has to be executed at the src host.
21
22 Move-Back: myrocks_hotbackup --move_back --datadir=<dest mysql datadir>
23 --rocksdb_datadir=<dest rocksdb datadir> --rocksdb_waldir=<dest rocksdb
24 wal dir> --backup_dir=<where backup files are stored> . You need to ex‐
25 ecute move-back command on a server where backup files are sent.
26
28 -h, --help
29 show this help message and exit
30
31 -i CHECKPOINT_INTERVAL, --interval=CHECKPOINT_INTERVAL
32 Number of seconds to renew checkpoint
33
34 -c CHECKPOINT_DIRECTORY, --checkpoint_dir=CHECKPOINT_DIRECTORY
35 Local directory name where checkpoints will be created.
36
37 -d DATADIR, --datadir=DATADIR
38 backup mode: src MySQL datadir. move_back mode: dest MySQL
39 datadir
40
41 -s OUTPUT_STREAM, --stream=OUTPUT_STREAM
42 Setting streaming backup options. Currently tar, WDT and xb‐
43 stream are supported. Default is tar
44
45 --destination=DESTINATION
46 Remote server name. Only used for WDT mode so far.
47
48 --avg_mbytes_per_sec=AVG_MBYTES_PER_SEC
49 Average backup rate in MBytes/sec. WDT only.
50
51 --extra_wdt_sender_options=EXTRA_WDT_SENDER_OPTIONS
52 Extra options for WDT sender
53
54 --extra_wdt_receiver_options=EXTRA_WDT_RECEIVER_OPTIONS
55 Extra options for WDT receiver
56
57 -u MYSQL_USER, --user=MYSQL_USER
58 MySQL user name
59
60 -p MYSQL_PASSWORD, --password=MYSQL_PASSWORD
61 MySQL password name
62
63 -P MYSQL_PORT, --port=MYSQL_PORT
64 MySQL port number
65
66 -S MYSQL_SOCKET, --socket=MYSQL_SOCKET
67 MySQL socket path. Takes precedence over --port.
68
69 -m, --move_back
70 Moving MyRocks backup files to proper locations.
71
72 -r ROCKSDB_DATADIR, --rocksdb_datadir=ROCKSDB_DATADIR
73 RocksDB target data directory where backup data files will be
74 moved. Must be empty.
75
76 -w ROCKSDB_WALDIR, --rocksdb_waldir=ROCKSDB_WALDIR
77 RocksDB target data directory where backup wal files will be
78 moved. Must be empty.
79
80 -b BACKUPDIR, --backup_dir=BACKUPDIR
81 backup mode for WDT: Remote directory to store backup.
82 move_back mode: Locations where backup files are stored.
83
84 -f, --skip_check_frm_timestamp
85 skipping to check if frm files are updated after starting
86 backup.
87
88 -D DEBUG_SIGNAL_FILE, --debug_signal_file=DEBUG_SIGNAL_FILE
89 debugging purpose: waiting until the specified file is created
90
92 For more information, please refer to the MariaDB Knowledge Base,
93 available online at https://mariadb.com/kb/
94
96 MariaDB Foundation (http://www.mariadb.org/).
97
98
99
100MariaDB 10.5 March 2020 MYROCKS_HOTBACKUP(1)