自动魔法字符串文档

计划中

顺着 DDL 跟踪一个来历不明的值,并给下一个人留条有用的备注——也许那个人就是未来的你。

在结果集中发现了神秘代码?当 SQLly 能顺着 DDL 内省,它会留下一条内联说明,解释这个值的来历,让查询能多回答一点关于自己的小知识。

SELECT status /* ← enum: orders.status_id → status_codes.code */

解释来自哪里

来自模式本身,按可信度排序——备注会说明用的是哪一种:

  1. 外键。 该值是引用另一张表的 ID:顺着它找出被引用的表,并指明该表及其可读列。
  2. 检查约束。 一个被约束限定为少量字面值的列,实际上就是枚举,只是名字不叫枚举,而且约束本身就写明了允许的取值集合。
  3. 一次查找匹配到多行,例如按不唯一的姓名匹配。 一个由代码和描述行组成的小表,通过名称而非声明的键连接,非常常见,值得识别。
  4. 一个扩展属性或列注释 - 你的团队其实早已写下答案,只是一直没有什么地方把它展示给你。
备注就是一条评论,绝不会改写。 解释会作为 SQL 注释插入,因此放在其他任何地方都不产生任何影响,提交进仓库后也依然保留,一个按键即可删除。你的查询含义和以前完全一样。

顺带生成文档

令人愉快的是它的改进方向:你反正都要去查这个,而这条备注意味着 下一个 人,很可能是未来的你,不必再查。它和 架构文档,只不过一次应用到一个令人费解的值上,而不是一次应用于整个数据库。

已计划。它所需的关系和约束模型已经存在,并且已经在支撑 JOIN 建议 和 显示值解析;它只是在既有内容之上呈现的新界面,并不是新知识。