pgagroal-cli(1)

💖 pgagroal-cli 💖

okay bestie, say hi to pgagroal-cli, the command line utility for pgagroal — it lives in the General Commands Manual section of the manual pages, and it's literally your little remote control for the pooler. 🎀

---

✨ SYNOPSIS ✨

pgagroal-cli [ -c CONFIG_FILE ] [ COMMAND ]

---

🌸 DESCRIPTION 🌸

pgagroal-cli is a command line utility for pgagroal. that's the whole vibe fr fr — it's the CLI bestie that talks to your pooler so you don't have to. 🦋

---

💅 OPTIONS 💅

these are the flags, no cap:

• -c,--config CONFIG_FILE — sets the path to the pgagroal.conf file
• -h,--host HOST — sets the host name
• -p,--port PORT — sets the port number
• -U,--user USERNAME — sets the user name
• -P,--password PASSWORD — sets the password
• -L,--logfile FILE — sets the logfile
• -F, --format text|json|raw — sets the output format
• -C, --compress none|gz|zstd|lz4|bz2 — compresses the wire protocol
• -E, --encrypt none|aes|aes256|aes192|aes128 — encrypts the wire protocol
• -v, --verbose — outputs a text string of the result
• -V, --version — displays version information
• -?, --help — displays help

---

👑 COMMANDS 👑

🌈 flush [mode] [database]

flushes connections according to [mode]. the allowed modes are:

• 'gracefully' (default) — flushes all connections gracefully 💖
• 'idle' — flushes only idle connections 😴
• 'all' — flushes all connections. USE WITH CAUTION! 💀

if no [database] name is specified, it applies to all databases.

🌈 ping

verifies if pgagroal is up and running, and checks connectivity to the configured PostgreSQL servers. with JSON output, the response includes per-server Host, Port, Status, Primary, and Behind on standbys. 👑

🌈 enable [database]

enables the specified database, or all databases if none is specified ✨

🌈 disable [database]

disables the specified database, or all databases if none is specified 🙈

🌈 shutdown [mode]

stops the pgagroal pooler. the [mode] can be:

• 'gracefully' (default): waits for active connections to quit 🫶
• 'immediate': forces connections to close and terminate 💥
• 'cancel': avoids a previously issued 'shutdown gracefully' 🛑

🌈 status [details]

status of pgagroal, with optional details. per-server fields match ping. details adds limits and per-connection rows. 🔍

🌈 switch-to <server>

switches to the specified primary server 🔄

🌈 conf <action>

manages the configuration. <action> can be:

• 'reload': issues a configuration reload 🔁
• 'ls': lists the configuration files used 📋
• 'get': obtains information about a runtime configuration value — usage: conf get <parameter_name> 👀
• 'set': modifies a configuration value — usage: conf set <parameter_name> <parameter_value> ✍️

🌈 clear <what>

resets either the Prometheus statistics or the specified server. <what> can be:

• 'server' (default) followed by a server name 🖥️
• a server name on its own 🏷️
• 'prometheus' to reset the Prometheus metrics 📊

---

😭 REPORTING BUGS 😭

pgagroal is licensed under the 3-clause BSD License.

---

🫶 SEE ALSO 🫶

pgagroal.conf(5), pgagroal_hba.conf(5), pgagroal_databases.conf(5), pgagroal_vault.conf(5), pgagroal(1), pgagroal-admin(1), pgagroal-vault(1)

---

and that's the whole page, bestie — this was pgagroal-cli(1) from the General Commands Manual, mwah 💋 slay, go flush something (gracefully, obviously) 🎀✨💅