手中有刀,心里有佛

SQL 样式指南 (SQL Style Guide)

范叶亮 / 2021-05-04


代码样式指南主要用于规范项目中代码的一致性,使得代码简单、可读和易于维护,从一定程度上也影响代码的质量。一句话概括如何评价代码的质量:

衡量代码质量的唯一有效标准:WTF/min – Robert C. Martin

Google 针对大多数编程语言(例如:C/C++,Java,JavaScript,Python,R 等)都整理了相关的代码风格,但对于 SQL 这种用于数据库查询特殊目的的编程语言并没有整理对应的风格。同其他编程语言代码风格一样,没有哪种风格是最好的,只要在项目中采用统一合理的风格即可。

本文参考的 SQL 样式指南有如下几种:

  1. https://www.sqlstyle.guide/zh/
  2. https://about.gitlab.com/handbook/business-technology/data-team/platform/sql-style-guide/
  3. https://docs.telemetry.mozilla.org/concepts/sql_style.html
  4. https://github.com/mattm/sql-style-guide

本文给出的 SQL 样式指南基于上述几种进行整理和修改。

一般原则

命名惯例

对齐和换行

明确指定

子查询

其他