pgFormatter::CLI(3) User Contributed Perl Documentation pgFormatter::CLI(3)

pgFormatter::CLI - Implementation of command line program to format SQL queries.

Version 5.5

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()

Object constructor, nothing fancy in here.

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.

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

Saves beautified query to whatever is output filehandle

Display message following the log level

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

Loads SQL from input file or stdin.

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

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

pgFormatter is an original work from Gilles Darold

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

Copyright 2012-2023 Gilles Darold. All rights reserved.

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.

2023-02-06 perl v5.36.0