backplane/pgformatter Docker 镜像 - 轩辕镜像

pgformatter

基于perl:5-slim的pgFormatter Docker镜像，pgFormatter是PostgreSQL SQL语法美化工具。

正如官方网站所述：

此SQL格式化/美化工具支持SQL-92、SQL-99、SQL-2003、SQL-2008、SQL-2011标准的关键字以及PostgreSQL特定关键字。也适用于其他数据库。

pgFormatter可作为控制台程序或CGI运行。它会自动检测环境，并根据上下文输出文本或HTML格式。

此镜像的源代码托管在GitHub的backplane/conex仓库。

核心功能与特性

• 多标准支持：兼容SQL-92至SQL-2011标准及PostgreSQL特定关键字
• 代码处理：美化PostgreSQL SQL查询和PL/PGSQL代码
• 灵活输入输出：支持从文件或标准输入（-）读取，输出到标准输出或指定文件
• 丰富格式化选项：
  • 调整缩进空格数（默认4空格）或使用制表符
  • 控制逗号位置（起始/结束）及换行（如INSERT语句逗号后换行）
  • 转换关键字、函数、数据类型大小写（小写/大写/首字母大写/不变）
  • ***化文字（隐藏敏感数据）、移除注释、语句编号
• 配置支持：可通过配置文件自定义规则，默认查找.pg_format、$HOME/.pg_format或XDG配置目录文件
• 多格式输出：支持文本（默认）或HTML格式

使用场景

• 开发者美化SQL代码，提升可读性和一致性
• 数据库管理员整理SQL脚本，统一团队代码风格
• CI/CD流程集成，自动格式化SQL文件
• 分享SQL代码前***化敏感数据（如密码、个人信息）

使用方法

帮助文本

使用-h或--help参数可查看完整帮助信息：

na
用法: pg_format [选项] file.sql

    PostgreSQL SQL查询和PL/PGSQL代码美化工具。

参数:

    file.sql可以是单个文件、多个文件，或使用-从标准输入读取查询。

    将格式化后的SQL输出到标准输出，或使用-o | --output选项指定的文件。

选项:

    -a | --anonymize      : ***化查询中的所有文字，在格式化前隐藏机密数据时有用。
    -b | --comma-start    : 在参数列表中，逗号起始（见-e）
    -B | --comma-break    : 在INSERT语句中，每个逗号后添加换行。
    -c | --config FILE    : 使用配置文件。默认不使用配置文件，除非存在./.pg_format、
                            $HOME/.pg_format或XDG基本目录文件$XDG_CONFIG_HOME/pg_format/pg_format.conf。
    -C | --wrap-comment   : 结合--wrap-limit，对注释应用重新格式化。
    -d | --debug          : 启用调试模式。默认禁用。
    -e | --comma-end      : 在参数列表中，逗号结束（默认）
    -f | --function-case N: 更改PostgreSQL函数的大小写。默认不变：0。取值：0=>不变，1=>小写，
                            2=>大写，3=>首字母大写。
    -F | --format STR     : 输出格式：text或html。默认：text。
    -g | --nogrouping     : 在事务重组中，语句间添加换行。默认是组合语句。
    -h | --help           : 显示此帮助信息并退出。
    -i | --inplace        : 用格式化内容覆盖输入文件。
    -k | --keep-newline   : 保留PL/pgSQL代码中的空行。
    -L | --no-extra-line  : 不在输出末尾添加额外的空行。
    -m | --maxlength SIZE : 查询的最大长度，超过给定大小将被截断。默认：不截断。
    -M | --multiline      : 为-p或--placeholder启用多行搜索。
    -n | --nocomment      : 从SQL代码中移除所有注释。
    -N | --numbering      : 在每个查询前添加语句编号作为注释。
    -o | --output file    : 定义输出文件名。默认：标准输出。
    -p | --placeholder RE : 设置正则表达式以查找不改变的代码。
    -r | --redshift       : 将RedShift关键字添加到SQL关键字列表。现已过时，
                            改用--extra-keyword 'redshift'。
    -s | --spaces size    : 更改缩进空格数，默认4个空格。
    -S | --separator STR  : 动态代码分隔符，默认为单引号。
    -t | --format-type    : 尝试对某些语句使用其他格式化类型。
    -T | --tabs           : 使用制表符代替空格，使用时空格数设为1，无论-s的值。
    -u | --keyword-case N : 更改保留关键字的大小写。默认大写：2。取值：0=>不变，1=>小写，
                            2=>大写，3=>首字母大写。
    -U | --type-case N    : 更改数据类型名称的大小写。默认小写：1。取值：0=>不变，1=>小写，
                            2=>大写，3=>首字母大写。
    -v | --version        : 显示pg_format版本并退出。
    -w | --wrap-limit N   : 将查询换行到指定长度。
    -W | --wrap-after N   : 列表换行的列数。默认：每个项目单独一行。
    -X | --no-rcfile      : 不自动读取配置文件（./.pg_format、$HOME/.pg_format或$XDG_CONFIG_HOME/pg_format）。
                            --config / -c选项覆盖此设置。
    --extra-function FILE : 包含函数列表的文件，使用与PostgreSQL内部函数相同的格式化。
    --extra-keyword FILE  : 包含关键字列表的文件，使用与PostgreSQL内部关键字相同的格式化。
                            使用特殊值'redshift'以支持pgFormatter内部定义的Redshift关键字。
    --no-space-function : 移除函数调用与左括号之间的空格。
    --redundant-parenthesis: 不在DML中移除冗余括号。

示例:

    cat samples/ex1.sql | /usr/local/bin/pg_format -
    /usr/local/bin/pg_format -n samples/ex1.sql
    /usr/local/bin/pg_format -f 2 -n -o result.sql samples/ex1.sql

常用示例

1. 格式化文件并输出到标准输出

sh
docker run --rm --volume "$(pwd):/work" backplane/pgformatter query.sql

2. 原地覆盖格式化文件（-i）

sh
docker run --rm --volume "$(pwd):/work" backplane/pgformatter -i query.sql

3. 从标准输入读取并输出到文件

sh
cat query.sql | docker run --rm -i backplane/pgformatter -o formatted.sql -

4. 自定义缩进（2空格）和关键字小写

sh
docker run --rm --volume "$(pwd):/work" backplane/pgformatter -s 2 -u 1 query.sql

5. ***化敏感数据并格式化

sh
docker run --rm --volume "$(pwd):/work" backplane/pgformatter -a sensitive_query.sql