pgFormatter::CGI(3)

📦
version 5.11 · 6 versions
, in arch rolling

💅 pgFormatter::CGI(3) — CGI-BIN but make it cute 💅

okay so bestie, welcome to the User Contributed Perl Documentation page for pgFormatter::CGI, and it's literally the implementation of a CGI-BIN script to format SQL queries. yes, we're doing Perl CGI in this economy and it absolutely slays. 🫶

💖 NAME 💖

pgFormatter::CGI — the implementation of a CGI-BIN script to format SQL queries. that's the whole name-and-what-it-does moment, bestie. 💅

🦋 VERSION 🦋

Version 5.11. that's the version, periodt. 👑

✨ SYNOPSIS ✨

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

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

no cap, that's the whole entry point vibe. 🎀

🎀 FUNCTIONS 🎀

🌱 new

Object constructor, calls set_config method to set default values for various parameters. it's giving setup era. 🧚

🚦 run

Route to the right handler based on what sort of data we receive. literally the traffic director of this whole situation. 🛣️

🌸 run_webpage

Wraps all work related to generating html page.

It calls set of functions to get CGI object, receive parameters from request, sanitize them, beautify query (if provided) and print ghtml. yes bestie, ghtml is right there in the original and we're keeping it. 💅

🌈 run_api

Wraps all work related to generating JSON response when used as API. API mode said "I'm the main character now." ✨

🫶 get_cgi

  • Creates CGI object, and sets POST size limit. 🛑
  • Sets config for the page and beautifier. URLs, names of auxiliary files, configuration for pgFormatter::Beautify module. 🎀
  • Loads, and returns, default CSS from __DATA__. 💖
  • Gets values of parameters, and possibly uploaded file from CGI object to structures in $self. 📥
  • Get params for the API version of this service. 🔌

🧼 sanitize_params

Overrides parameter values if given values were not within acceptable ranges. it's giving boundaries, bestie. 🚧

💖 beautify_query

Runs beautification on provided query, and stores new version in $self->{'content'}. glow-up for your SQL, fr fr. ✨

Outputs beautified SQL as JSON.

Outputs body of the page. two jobs, one function, we love a multitasker. 💅

Outputs footer of the page. the little bow on top. 🎀

😭 _load_optional_file

Helper function to try to load file. If it succeeds, it returns file content, it not, it returns empty string (instead of dying). yes, "it not" — we keep the typo energy, no cap. 🫶

Outputs an error message when no acceptable response is found. dramatic? maybe. necessary? absolutely. 💀

Outputs page headers - both HTTP level headers, and HTML. both layers, bestie. 🧚

🌈 DATA 🌈

__DATA__ section (at the end of this file) is used to store default CSS Style, so that it will not "pollute" Perl code, and will not need to be indented. aesthetic and functional, we love to see it. 🎀

👑 AUTHOR 👑

pgFormatter is an original work from Gilles Darold. iconic author moment. 👑

💀 BUGS 💀

Please report any bugs or feature requests to: https://github.com/darold/pgFormatter/issues. do it bestie, the issues page is waiting. 🐛

Copyright 2012-2026 Gilles Darold. All rights reserved. 💖

🧚 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. 🧚

and that's the whole page, bestie — it came from perl v5.42.2, dated 2026-09-04, and it's pgFormatter::CGI(3). mwah 💋✨

📦 where this page comes from