SQL基本编码规范

保持可重复性和透明度是数据团队的核心价值,而SQL基本的编码规范可以帮助我们实现这一目标。此外,在使用SQL时,遵循本样式指南中的基本规则将提高我们共享,维护和扩展研究范围的能力。好的编码格式是的业务逻辑更容易理解和扩展,减少开发的成本。

基本准则


  • 没有tab。使用2个空格缩进
  • 没有尾随空格。
  • 始终大写SQL关键字(例如SELECT或AS)
  • 变量名应用下划线分隔:
-- GOOD:
SELECT COUNT(*)AS backers_count
-- BAD:
SELECT COUNT(*)AS backersCount
  • 注释应位于查询顶部附近,或至少靠近最近的SELECT位置
  • 尝试对不明显的查询做注释,比如为什么这个ID要硬编码
  • 在给定上下文的情况下,不要使用单字母变量名称来尽可能地描述:
-- GOOD:
SELECT ksr.backings AS backings_with_creators
-- BAD:
SELECT ksr.backings AS b
  • 尽早并经常使用通用表表达式,并为其命名。

SQL代码必须正确有效地工作。但这还不够。除非您是一个人工作,有完善的记忆力并且计划永远不更改工作,否则您需要注释和记录代码,它必须具有固有的可读性,布局合理,使用易于理解的名称和明显的名称,并且必须健壮且具有弹性。

git diff 命令
Go模块管理:goproxy.io