pgFormatter::CLI(3pm)

pgFormatter::CLI3pm

Implementation of command line program to format sql queries.

Usage

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

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

Version

Version 5.11

Functions

new

Object constructor, nothing fancy in here.

run

Wraps all work related to pg_format CLI program. This includes calling methods to read command line parameters, validate them, read query, beautify it, and output.

beautify

Actually formats loaded query using pgFormatter::Beautify library. If necessary runs anonymization.

save_output

Saves beautified query to whatever is output filehandle

logmsg

Display message following the log level

show_help_and_die

As name suggests - shows help page, with optional error message, and ends program.

load_sql

Loads SQL from input file or stdin.

get_command_line_args

Parses command line options into $self->{'cfg'}.

validate_args

Validates that options parsed from command line have sensible values, opens input and output files.

Releases

5 releases since Debian 10 (Buster); the text changed 4 times.

  1. 10
  2. 11
  3. 12
  4. 13
  5. Arch

Author

pgFormatter is an original work from Gilles Darold

Bugs

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

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.

From pgformatter 5.11-1 in Arch Linux 2026-11-01. Parsed by carta from the page's man source.