MYROCKS_HOTBACKUP(1)

📦
version 13.0.2 · 3 versions
, in alpine 3.22, alpine 3.23, alpine 3.24, arch rolling, debian bookworm, ubuntu stonking

💅 NAME 💅

myrocks_hotbackup — streaming backup for MariaDB MyRocks, bestie edition ✨

🌸 DESCRIPTION 🌸

Okay so real talk, here's how you actually run this thing:

🎀 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 gotta run that backup command on the server where you're taking backups from, mkay? No cap, set -o pipefail is there for a reason — she's keeping your pipeline honest 🫶

🦋 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>

Heads up: this one gets 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>

And this one? You run it on the server where the backup files got sent to. Move-back is literally the reverse-glow-up era 💅

✨ OPTIONS ✨

  • -h, --help — show this help message and exit. Iconic behavior, honestly 🌈
  • -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 — in backup mode: the src MySQL datadir. in move_back mode: the 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 🐛
Lowkey important: those RocksDB target dirs for --rocksdb_datadir and --rocksdb_waldir must be empty. Like, actually empty. Don't test her 💀

🌟 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/) 🫶

That's the whole vibe, bestie — this page is from MariaDB 10.11, dated 15 May 2020. Slay, go back up your RocksDB now ✨🎀🦋

📦 where this page comes from