sql-formatter

基于alpine:edge的sql-formatter工具Docker镜像，该工具用于格式化SQL查询。

正如官网所述：

SQL Formatter是一个用于格式化SQL查询的JavaScript库[...]支持以下数据库方言：

• sql - 标准SQL

• mariadb - MariaDB
• mysql - MySQL
• postgresql - PostgreSQL
• db2 - IBM DB2
• plsql - Oracle PL/SQL
• n1ql - Couchbase N1QL
• redshift - Amazon Redshift
• spark - Spark
• tsql - SQL Server Transact-SQL

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

核心功能与特性

• 多方言支持：兼容多种数据库SQL方言，包括MySQL、PostgreSQL、Oracle PL/SQL、SQL Server T-SQL等
• 轻量级：基于alpine:edge构建，镜像体积小，资源占用低
• 灵活使用：支持从标准输入读取SQL或指定文件，输出至标准输出或文件，也可原地更新文件
• 易于集成：可通过Docker快速部署，适合开发环境或CI/CD流程

使用场景

• 开发人员格式化SQL代码，提升可读性
• 团队统一SQL代码风格，规范代码格式
• 自动化流程中集成SQL格式化步骤，确保代码质量

使用方法

交互式使用

以下shell函数可辅助交互式运行该镜像：

sh
sql_formatter() {
  docker run \
    --rm \
    --interactive \
    --tty \
    --volume "$(pwd):/work" \
    "backplane/sql-formatter" \
    "$@"
}

将上述函数添加到shell配置文件（如.bashrc或.zshrc）后，可通过sql_formatter命令调用工具。

查看帮助信息

运行带-h参数的命令可查看完整使用说明：

usage: sql-formatter [-h] [-o OUTPUT] [--fix]
                     [-l {bigquery,db2,hive,mariadb,mysql,n1ql,plsql,postgresql,redshift,spark,sqlite,sql,trino,transactsql,tsql,singlestoredb,***}]
                     [-c CONFIG] [--version]
                     [FILE]

SQL Formatter

位置参数:
  FILE                  输入SQL文件（默认为标准输入）

可选参数:
  -h, --help            显示帮助信息并退出
  -o OUTPUT, --output OUTPUT
                        输出SQL的文件路径（默认为标准输出）
  --fix                 原地更新文件
  -l {bigquery,db2,hive,mariadb,mysql,n1ql,plsql,postgresql,redshift,spark,sqlite,sql,trino,transactsql,tsql,singlestoredb,***}, --language {bigquery,db2,hive,mariadb,mysql,n1ql,plsql,postgresql,redshift,spark,sqlite,sql,trino,transactsql,tsql,singlestoredb,***}
                        SQL格式化方言（默认为基本sql）
  -c CONFIG, --config CONFIG
                        配置JSON文件路径（未指定则使用默认配置）
  --version             显示程序版本号并退出

常用命令示例

1. 格式化标准输入的SQL并输出到标准输出：

   sh
   echo "SELECT * FROM users WHERE id=1;" | sql_formatter -l mysql
   

2. 格式化指定文件并输出到新文件：

   sh
   sql_formatter -l postgresql -o formatted.sql unformatted.sql
   

3. 原地更新SQL文件（需谨慎使用）：

   sh
   sql_formatter --fix -l tsql example.sql