pgFormatter 安装和配置指南

1. 项目基础介绍和主要编程语言

项目介绍

pgFormatter 是一个 PostgreSQL SQL 语法美化工具，能够将复杂的 SQL 查询和 PL/PGSQL 代码格式化为更易读的格式。它支持 SQL-92、SQL-99、SQL-2003、SQL-2008、SQL-2011 以及 PostgreSQL 特有的关键字。pgFormatter 可以作为命令行工具或 CGI 脚本运行，自动检测环境并输出格式化的文本或 HTML。

主要编程语言

pgFormatter 主要使用 Perl 语言编写。

2. 项目使用的关键技术和框架

关键技术

• Perl: 项目的主要编程语言，用于实现 SQL 格式化和美化功能。
• CGI: 支持作为 CGI 脚本运行，适用于 Web 环境。
• PostgreSQL: 专门针对 PostgreSQL 数据库的 SQL 语法进行优化。

框架

• 命令行工具: 提供命令行接口，方便用户在终端中直接使用。
• Web 接口: 通过 CGI 脚本，用户可以在浏览器中访问并使用 pgFormatter。

3. 项目安装和配置的准备工作和详细安装步骤

准备工作

在开始安装之前，请确保您的系统已经安装了以下软件：

• Perl: 确保 Perl 已经安装并配置好。
• Git: 用于从 GitHub 克隆项目代码。
• cURL 或 Wget: 用于下载安装包。

详细安装步骤

步骤 1: 克隆项目代码

首先，从 GitHub 克隆 pgFormatter 项目代码到本地：

git clone https://github.com/darold/pgFormatter.git

步骤 2: 进入项目目录

进入克隆下来的项目目录：

cd pgFormatter

步骤 3: 安装依赖模块

确保系统中已经安装了 Perl 的 autodie 模块。如果没有安装，可以使用以下命令进行安装：

sudo yum -y install perl-autodie  # 适用于 CentOS/RHEL
sudo apt-get install libautodie-perl  # 适用于 Debian/Ubuntu

步骤 4: 编译和安装

使用 Perl 的 Makefile.PL 脚本进行编译和安装：

perl Makefile.PL
make
sudo make install

默认情况下，pgFormatter 会被安装到 /usr/local/bin/pg_format 目录下，手册页会被安装到 /usr/local/share/man/man1/pg_format.1。

步骤 5: 验证安装

安装完成后，可以通过以下命令验证 pgFormatter 是否安装成功：

pg_format --version

如果安装成功，您将看到 pgFormatter 的版本信息。

配置指南

命令行使用

pgFormatter 可以直接在命令行中使用，格式化 SQL 文件：

pg_format input.sql -o output.sql

CGI 使用

如果您希望在 Web 环境中使用 pgFormatter，可以将其安装到 CGI 目录，并确保 CGI 脚本具有执行权限。

cp pg_format /var/www/cgi-bin/
chmod +x /var/www/cgi-bin/pg_format

然后，您可以通过浏览器访问 CGI 脚本，例如：

http://yourserver/cgi-bin/pg_format

常见问题

• Perl 模块缺失: 如果在安装过程中遇到 Perl 模块缺失的问题，可以使用 cpan 或 cpanm 工具安装缺失的模块。
• 权限问题: 在执行 make install 时，可能需要使用 sudo 提升权限。

通过以上步骤，您应该能够成功安装并配置 pgFormatter，开始使用它来美化您的 PostgreSQL SQL 代码。