pgFormatter::CLI(3)

📦
version 5.11 · 2 versions
, in nixpkgs unstable

💖 pgFormatter::CLI 💖

okay bestie, welcome to the manual page for pgFormatter::CLI — yes, the User Contributed Perl Documentation one, and the manual name is literally pgFormatter::CLI(3), so you know exactly where you are 💅✨

🌸 NAME 🌸

pgFormatter::CLI — it's the implementation of the command line program that formats SQL queries. That's the whole assignment: SQL queries get formatted, and this module is the CLI implementation doing it 💖

🎀 VERSION 🎀

Version 5.11 — periodt.

🦋 SYNOPSIS 🦋

This module gets called by the pg_format program when it detects it is not being run in a CGI environment. In that case, all control over flow is passed to this module by calling:

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

✨ FUNCTIONS ✨

💖 new 💖

It's the object constructor, and there is nothing fancy in here — lowkey simple, highkey essential 🫶

💖 run 💖

Wraps all work related to the pg_format CLI program. This includes calling methods to read command line parameters, validate them, read query, beautify it, and output. Basically it's the main character of the CLI flow 👑

💖 beautify 💖

Actually formats loaded query using the pgFormatter::Beautify library. If necessary, it runs anonymization. So yes, it's giving "make the SQL pretty" energy, with a little anonymous glow-up when needed 🌈

💖 save_output 💖

Saves beautified query to whatever is output filehandle. That filehandle? Whoever it is, it's getting the formatted query 🎀

💖 logmsg 💖

Display message following the log level. Logging but make it on brand 💬

💖 show_help_and_die 💖

As name suggests — shows help page, with optional error message, and ends program. Dramatic exit? Maybe. Helpful exit? Absolutely 💅

💖 load_sql 💖

Loads SQL from input file or stdin. SQL comes from somewhere, and this function is the one handling it 🦋

💖 get_command_line_args 💖

Parses command line options into $self->{'cfg'}. All the CLI args get parsed into that config hash, no cap ✨

💖 validate_args 💖

Validates that options parsed from command line have sensible values, opens input and output files. It's the vibe check for your arguments and your filehandles 🔥

👑 AUTHOR 👑

pgFormatter is an original work from Gilles Darold. Iconic behavior, honestly 💜

💀 BUGS 💀

Please report any bugs or feature requests to: https://github.com/darold/pgFormatter/issues

Bestie, if something is broken, take it to the issues page — that's the move 🙈

Copyright 2012-2026 Gilles Darold. All rights reserved. Respect the copyright, periodt 🎀

🧚 LICENSE 🧚

pgFormatter is free software distributed under the PostgreSQL Licence.

A modified version of the SQL::Beautify Perl Module is embedded in pgFormatter with copyright (C) 2009 by Jonas Kramer and is published under the terms of the Artistic License 2.0.

Two licenses, two icons, one very legal little moment 💅✨

okay that's the whole page bestie 🫶 the footer says perl v5.42.3, dated 1980-01-01, and it's the manual for pgFormatter::CLI(3) — bye! 💖🎀
📦 where this page comes from