pgFormatter::CLI(3)

💅 pgFormatter::CLI(3)

okay bestie, welcome to the manual page for pgFormatter::CLI 💖 this is a Perl module — the actual command-line brain of the pg_format program — and trust, it's way less scary than it sounds. pull up a chair, grab a lil snack 🍓, and let's get into it.

---

✨ NAME ✨

pgFormatter::CLI — literally the implementation of the command line program that formats SQL queries. that's the whole vibe. 💅

---

🎀 VERSION 🎀

Version 5.11 — yes, we're on 5.11, iconic, no notes. ⭐

---

🌸 SYNOPSIS 🌸

so here's the situation: this module gets called by the pg_format program, but only when it peeks around and realizes it's not being run in a CGI environment. when that happens, all the control over the flow gets passed straight to this module like "here u go bestie, it's yours now" 🫶. the calling looks like this:

my $program = pgFormatter::CLI->new();
$program->run()

---

🦋 FUNCTIONS 🦋

🌈 new

the object constructor! it does exactly what you think and nothing fancy in here. lowkey the chillest method in the whole file 😌

🔥 run

this one wraps up all the work related to the pg_format CLI program — main character energy fr fr 👑. that includes calling the methods to read the command line parameters, validate them, read the query, beautify it, and output. the whole glow-up pipeline, start to finish ✨

💜 beautify

actually formats the loaded query using the pgFormatter::Beautify library. and if it's necessary? it runs anonymization too 🙈. cute and responsible.

🧚 save_output

saves the beautified query to whatever output filehandle is in play. it's giving "deliver the goods" 📦

💀 logmsg

displays a message, following the log level. simple, effective, slays 🌟

🙈 show_help_and_die

as the name suggests (and honestly, what a name 😭) — it shows the help page, with an optional error message, and then ends the program. dramatic exit? yes. correct? also yes.

🎀 load_sql

loads the SQL from an input file or from stdin. no cap, that's it 🌸

⭐ get_command_line_args

parses command line options into $self->{'cfg'}. all the flags go in, nice and tidy 🧺

🫶 validate_args

validates that the options parsed from the command line have sensible values, and opens the input and output files. the vibe check of the whole operation ✅💅

---

🌟 AUTHOR 🌟

pgFormatter is an original work from Gilles Darold. give credit where credit is due, periodt 👑

---

🐛 BUGS 🐛

please report any bugs or feature requests to: https://github.com/darold/pgFormatter/issues. don't suffer in silence bestie, tell the maintainers 🫶

---

💖 COPYRIGHT 💖

Copyright 2012-2026 Gilles Darold. All rights reserved.

---

🌸 LICENSE 🌸

pgFormatter is free software distributed under the PostgreSQL Licence. slay 💅

also important: a modified version of the SQL::Beautify Perl Module is embedded in pgFormatter with copyright (C) 2009 by Jonas Kramer, and it's published under the terms of the Artistic License 2.0. gotta credit the embedded icon too 🎀

---

and that's the page!! ty for reading, mwah 💋 — this was perl v5.42.2, dated 2026-09-04, and you just consumed pgFormatter::CLI(3) in full. go format some SQL, you absolute legend 🌈✨