sqlfluff/sqlfluff

SQLFluff官方Docker镜像

面向开发者的SQL代码检查工具

SQLFluff是一款支持多种SQL方言、可灵活配置的SQL代码检查工具。其设计初衷面向ELT应用场景，同时支持Jinja模板和dbt，能够自动修复大多数代码检查错误，让开发者专注于核心业务逻辑。

本仓库包含SQLFluff的Docker镜像，镜像通过GitHub Actions构建，确保最新版本及时上传至DockerHub。

核心功能与特性

• 方言灵活性：支持多种SQL方言，适应不同数据库环境需求
• 可配置性：支持自定义检查规则，满足团队特定代码规范
• 模板支持：兼容Jinja模板和dbt，适配数据建模流程
• 自动修复：可自动修复多数检查错误，提升开发效率
• Docker化部署：通过容器化方式快速部署，避免环境依赖问题

使用场景与适用范围

• ELT流程中的SQL代码质量检查与优化
• dbt项目的SQL代码规范统一与错误修复
• 团队协作中SQL代码风格的一致性保障
• CI/CD流程中集成SQL自动化检查步骤
• 本地开发环境的SQL代码实时检查

使用方法与配置说明

拉取镜像

通过以下命令拉取指定版本的SQLFluff镜像：

console
docker pull sqlfluff/sqlfluff:<version_tag>

（将<version_tag>替换为具体版本号，如3.2.0）

运行SQLFluff命令

基本命令格式：

console
docker run -it --rm -v $PWD:/sql sqlfluff/sqlfluff:<version_tag> [子命令] [文件/目录]

示例（检查test.sql文件）：

console
docker run -it --rm -v $PWD:/sql sqlfluff/sqlfluff:<version_tag> lint test.sql

（子命令可根据需求替换为fix（修复）、parse（解析）等）

创建命令别名（推荐）

为简化使用，建议在shell配置文件中添加别名：

console
alias sqlfluff='docker run -it --rm -v $PWD:/sql sqlfluff/sqlfluff:<version_tag>'

添加别名后，可直接使用类Python CLI的命令格式：

console
sqlfluff lint test.sql  # 检查SQL文件
sqlfluff fix test.sql  # 自动修复SQL文件错误
sqlfluff parse test.sql  # 解析SQL文件结构

补充信息

有关SQLFluff的更多详细信息，请参考官方文档：

• CLI参考：[***]
• 配置指南：[***]