SQLfmt: 一键美化你的SQL代码

SQLfmt: 一键美化你的SQL代码

sqlfmtSQL formatter with width-aware output项目地址:https://gitcode.com/gh_mirrors/sq/sqlfmt

项目介绍

SQLfmt 是一款专为 dbt（数据构建工具）设计的 SQL 自动格式化器，它旨在提高 SQL 代码的可读性和一致性。支持多种主要数据库方言如 PostgreSQL、MySQL、Snowflake、BQ 和 Redshift 的 SELECT 语句格式化。此工具特别适合于在版本控制系统（如 Git）中的 dbt 项目，确保代码风格统一，且易于团队协作及回溯。尽管在处理特定方言和 DDL/DML 时仍处于早期阶段，但其核心功能已经相当成熟。

项目快速启动

安装 SQLfmt

首先，你需要安装 SQLfmt。推荐使用 pipx 来安装以避免环境冲突：

pipx install shandy-sqlfmt

如果你想同时处理 Jinja 模板，可以加上 [jinjafmt] 参数：

pipx install shandy-sqlfmt[jinjafmt]

格式化文件

安装完成后，你可以方便地格式化当前目录下所有 SQL 文件：

sqlfmt

对于快速检查而不是实际修改文件，使用 --check 选项：

sqlfmt --check

查看修改前后的差异而不直接修改文件，可以使用 --diff 选项：

sqlfmt --diff

应用案例和最佳实践

1. 日常代码审查流程：集成到Git工作流中，在提交代码之前运行 sqlfmt 确保所有SQL脚本格式一致。
2. dbt项目维护：在dbt项目开发过程中，利用SQLfmt保持Jinja模板与SQL语句的格式清晰有序，提升项目的可维护性。
3. 教育训练：在教授SQL或数据工程课程时，使用SQLfmt作为编码标准工具，帮助学生养成良好的编程习惯。

最佳实践提示

• 预先备份：首次使用前进行代码备份，防止意外格式更改导致的问题。
• 版本控制集成：在预提交钩子中使用SQLfmt，自动格式化即将提交的代码。
• 配置线长：通过 --line-length 或 -l 设置合适的行长度，默认是88字符。

典型生态项目

虽然SQLfmt本身专注于SQL格式化，但它与其他技术栈和工具的结合使用构成了其生态系统的一部分。例如：

• pre-commit: 可以配置成git的pre-commit hook，保证每次提交前代码都经过格式化。
• VSCode插件: 开发者可以探索与Visual Studio Code等IDE集成的插件，实现代码高亮和实时格式化。

通过这些整合，SQLfmt不仅限于命令行工具，而是成为数据工程师和分析师日常工作中不可或缺的部分，促进了代码质量和工作效率的双重提升。

---

此教程提供了快速上手SQLfmt的基本指南，深入应用时建议详细阅读官方文档，获取最新特性和更高级的配置方法。

sqlfmtSQL formatter with width-aware output项目地址:https://gitcode.com/gh_mirrors/sq/sqlfmt