MYSQLROUTER_KEYRING(1)

💅 MYSQLROUTER_KEYRING(1) — MySQL Router Keyring Tool 🎀

okay bestie, so this is the mysqlrouter_keyring page from the MySQL Router manual set, and honestly? it's a glow-up era for your keyrings ✨

---

🌸 NAME 🌸

mysqlrouter_keyring — the MySQL Router Keyring Tool. that's it, that's the name, and it's iconic.

---

🦋 SYNOPSIS 🦋

mysqlrouter_keyring [options]

literally just the tool plus some options. we love a simple entrance 💅

---

✨ DESCRIPTION ✨

so mysqlrouter_keyring is a command line application for managing MySQL Router key rings. yes, key rings. like jewelry but for your secrets 💖 it's a whole vibe.

Usage information:

🎀 Generic commands 🎀

• --help — shows you the usage information. your little map when you're lost 🗺️
• --version — prints the tool's version. so you know exactly which era you're in ⭐

🔐 Keyring commands 🔐

heads up bestie: all of these commands also accept --master-key-reader and --master-key-writer instead of --master-key-file. not me giving you options 😭

• init — Initialize keyring with a master-key-file.

Creates a keyring and master-key-file if they do not exist; and adds keyring to master-key-file if it does not yet exist there. it's giving "let there be light" but for files 🕯️

• list — List usernames stored in the keyring; or list properties of a user stored in the keyring. a little peek inside, no big deal 👀
• get — Get property of user from the keyring. one specific thing, served fresh 🍓
• export — Export all entries of the keyring as JSON. everything, all at once, in JSON — slay 💅
• set — Add or overwrite account of the user in the keyring file. new or updated, either way it ate 🔥
• delete — Delete user from the keyring. bye bestie, no hard feelings 👋

👑 Master-key commands 👑

• master-key-list — List keyring-ids from master-key-file. roll call 📋
• master-key-delete — Delete master-key from "keyring" from master-key-file. yes, the quotes around "keyring" are literally in the original, keep them 🫶
• master-key-rename — Rename keyring-id in a master-key-file. a name change, main character energy ✨

💜 Examples 💜

here's where it gets real — copy these exactly, fr fr:

$> mysqlrouter_keyring init --master-key-file=mysqlrouter.key data/keyring
$> mysqlrouter_keyring list --master-key-file=mysqlrouter.key data/keyring
$> mysqlrouter_keyring list --master-key-file=mysqlrouter.key data/keyring user
$> mysqlrouter_keyring get --master-key-file=mysqlrouter.key data/keyring someuser key
$> mysqlrouter_keyring export --master-key-file=mysqlrouter.key data/keyring
$> mysqlrouter_keyring set --master-key-file=mysqlrouter.key data/keyring user key value
$> mysqlrouter_keyring delete --master-key-file=mysqlrouter.key data/keyring user
$> mysqlrouter_keyring delete --master-key-file=mysqlrouter.key data/keyring user key
$> mysqlrouter_keyring master-key-list --master-key-file=mysqlrouter.key
$> mysqlrouter_keyring master-key-delete --master-key-file=mysqlrouter.key data/keyring
$> mysqlrouter_keyring master-key-rename --master-key-file=mysqlrouter.key data/keyring other/data/keyring

that's eleven examples, go practice them and come back when you're obsessed 🌈

---

📜 COPYRIGHT 📜

Copyright © 2006, 2024, Oracle and/or its affiliates.

This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License. so yes, free, but read the terms bestie 🧚

This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. like, it's free but it's not magic, yk? 💀

You should have received a copy of the GNU General Public License along with the program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or see http://www.gnu.org/licenses/. paper mail, iconic 🙈

---

🫶 AUTHOR 🫶

Oracle Corporation (http://dev.mysql.com/). periodt. 💜

---

ok that's the whole page, nothing skipped, every flag and example accounted for — vibe check passed ✅

---

✨ cute sign-off time ✨ this little gem comes from MySQL 8.4, dated 03/11/2024 — and yeah, that's the same MYSQLROUTER_KEYRING(1) we've been screaming about this whole time 💖 go forth and keyring, bestie 🎀