マジック文字列の自動ドキュメント化

予定

説明のない値を DDL の中でたどり、次に触る人(場合によっては未来の自分)のために役立つメモを残せます。

結果セットに謎のコードを見つけましたか? SQLly が値をたどって追跡できる場合、 DDL イントロスペクション、値の出どころを説明するインラインのメモを残すため、クエリが自分自身の小ネタを少しだけ答えてくれます。

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

説明の出どころ

スキーマから、信頼度の高い順に。どれを使ったかはメモに表示されます:

  1. 外部キー。 値は別のテーブルへの ID です。それをたどり、参照先のテーブルと、その読みやすい列の名前を表示します。
  2. チェック制約。 いくつかのリテラル値だけに制約された列は、名前以外はすべて列挙型であり、その制約が許可される値の集合を明示しています。
  3. ルックアップテーブル。 宣言されたキーではなく名前で結合された、コードと説明の行からなる小さなテーブルです。非常に一般的なパターンで、認識しておく価値があります。
  4. 拡張プロパティまたは列コメント - チームがすでに答えを書き留めているのに、それを見せるものが何もなかった場所。
メモはコメントであり、書き換えではありません。 説明は SQL コメントとして挿入されるため、他の場所では何の影響もなく、リポジトリにコミットされても残り、キー 1 回で削除できます。クエリの意味は、以前とまったく変わりません。

ドキュメントは副産物

うれしいのは進む方向です。どうせ調べるつもりだったはずで、このメモは 次へ 人(おそらく未来の自分自身ですが)が改めて調べなくて済みます。これは ドキュメントスキーマ、データベース全体を一度に適用するのではなく、理解しにくい値を 1 つずつ適用します。

計画中です。必要となるリレーションシップと制約のモデルはすでに存在し、すでに次の機能を支えています 結合候補 そして 表示値の解決; これは新しい知識ではなく、既存の仕組みの上に載った新しいインターフェイスです。