自動魔法字串文件
已規劃透過 DDL 追蹤一個無法解釋的值,並為下一個人(或許就是未來的你)留下有用的註解。
在結果集中發現看不懂的代碼?當 SQLly 能夠一路追蹤這個值時 DDL 探查,它會留下行內註記,說明這個值是怎麼來的,讓查詢順便多交代一點自己的小知識。
SELECT status /* ← enum: orders.status_id → status_codes.code */
解釋的來源
來自結構描述,按可信度高低排序——備註會說明它用的是哪一個:
- 外鍵。 這個值是指向另一個資料表的 ID:循著它指名被參照的資料表,以及其中適合閱讀的欄位。
- CHECK 約束。 只允許少數幾個字面值的欄位,除了名字不叫列舉,根本就是列舉,而約束本身就把允許的集合寫得清清楚楚。
- 一個查閱用資料表。 用「程式碼+描述」資料列組成的小型資料表,靠名稱而非宣告的鍵來連接,非常常見,值得學會辨認。
- 擴充屬性或欄位註解 - 你的團隊早就把答案寫在那裡,卻一直沒有任何東西把它秀給你看。
筆記只是註解,絕不會改寫。 說明會以 SQL 註解的形式插入,因此在其他地方不會產生作用,提交到儲存庫後也會保留,按一個鍵就能刪除。你的查詢意義和原本完全相同。
文件是順手產出的副產品
令人愉快的部分是前進的方向:反正你本來就會去尋找,而這個註解意味著 下一個 人,很可能是未來的你,就不必再查。這和 結構描述文件,一次只處理一個讓人困惑的值,而不是一口氣處理整個資料庫。
已列入計畫。所需的關聯與約束模型已經存在,並已用於 聯結建議 和 顯示值解析;這是在其之上打造的新介面,而不是新的知識。