MYSQL-ZRM-PURGE(1)

✨ mysql-zrm-purge ✨

okay bestie, gather round, because this little icon 💅 is the ZRM for MySQL utility that purges backups that have gone past their retention policy date. Yes, it's the girl who cleans out your closet. No cap.

---

🌸 NAME 🌸

mysql-zrm-purge — the utility that yeets backups which have outlived their retention policy date in ZRM for MySQL. it's giving "spring cleaning but make it a cron job" 🧹✨

---

🦋 SYNOPSIS 🦋

mysql‐zrm‐purge
                [‐‐destination directory name]
                [‐‐options‐file filename]
                [‐‐quiet|‐‐no‐quiet]
                [‐‐verbose]
                [‐‐help]

---

💖 DESCRIPTION 💖

So here's the tea 🍵 — this utility removes expired backups (and "expired" means based on retention policies you specified during backup, not vibes) from the ‐‐destination directory you point it at. she does not guess. she follows the policy. periodt.

pls go read the ZRM for MySQL documentation at http://mysql-backup.zmanda.com/ for the deets on how to configure and use ZRM for MySQL. it's the main character of this whole story, fr fr. 📚

---

🎀 OPTIONS 🎀

• ‐‐destination directory name — tell her where the backups live. the default location is /var/lib/mysql-zrm/. if you do specify this option, the directory must already exist and it should be writable by the ZRM for MySQL user. if it isn't? she exits with an error. no backup purge for you 😭
• ‐‐options‐file filename — set the file (with the full pathname, bestie, full path, don't be shy) that contains MySQL command options.
• ‐‐tmpdir temporary directory to be used — the full path of the directory to be used for storing temporary files and directories on the backup host. if you don't specify it, it defaults to the system specified temporary directory on the backup host, e.g. /tmp. 🗂️
• ‐‐quiet|‐‐no‐quiet — choose quiet to suppress display of log messages on stdout. choose no-quiet to display the log messages to standard output (stdout). the default is ‐‐no-quiet. (so yes, she's chatty by default. iconic behaviour honestly.) 🗣️
• ‐‐verbose — give me MORE detail in the log. verbose output is turned off by default. turn it on when you want the full director's commentary. 🔍
• ‐‐help — displays the help message and exits. ⚠️ heads up: this is a command line only parameter, so it cannot be specified in the configuration file. don't try it, she will not play.

---

🌈 FILES 🌈

• /var/lib/mysql‐zrm — the directory under which all backup data is stored. her house. her rules. 🏠
• /etc/mysql‐zrm/backup set name/mysql‐zrm.conf — the configuration file read by ZRM for MySQL.

---

⭐ RETURN VALUES ⭐

on success, zero is returned. on error, a non-zero value is returned. simple as that, bestie — 0 is the slay, anything else is the 💀.

---

👑 SEE ALSO 👑

• mysql‐zrm(1)
• mysql‐zrm‐backup(1)
• mysql‐zrm‐manage‐backup(1)
• mysql‐zrm‐restore(1)
• mysql‐zrm‐check(1)
• mysql‐zrm‐list(1)
• mysql‐zrm‐getconf(1)
• mysql‐zrm‐setconf(1)
• mysql‐zrm‐parse‐binlogs(1)
• mysql‐zrm‐extract‐backup(1)
• mysql‐zrm‐verify‐backup(1)
• mysql‐zrm‐abort‐backup(1)
• mysql‐zrm‐scheduler(1)
• mysql‐zrm‐reporter(1)
• mysql‐zrm.conf(5)
• mysqldump(1)
• mysqlbinlog(1)
• mysql(1)
• lvm(8)
• Zmanda Recovery Manager for MySQL (http://mysql-backup.zmanda.com/)

the whole friend group, honestly 🫶

---

💜 AUTHOR 💜

Zmanda Inc. (http://www.zmanda.com)

---

and that's the whole page, bestie!! this one came to you from Zmanda, Inc., and it's part of ZRM for MySQL — filed under mysql‐zrm‐purge(1). now go purge responsibly, she's watching 👀💖