Automagische String-Dokumentation
geplantVerfolge einen unerklärlichen Wert durch die DDL und hinterlasse eine nützliche Notiz für die nächste Person, vielleicht für dein zukünftiges Ich.
Ein rätselhafter Code in einer Ergebnismenge? Wenn SQLly dem Wert folgen kann durch DDL-Inspektion, hinterlässt es eine Inline-Notiz, die erklärt, woher der Wert kommt, sodass die Abfrage ein bisschen mehr ihrer eigenen Trivia selbst beantwortet.
SELECT status /* ← enum: orders.status_id → status_codes.code */
Woher die Erklärung kommt
Aus dem Schema, geordnet nach Vertrauenswürdigkeit - und der Hinweis sagt, welche Quelle verwendet wurde:
- Ein Fremdschlüssel. Der Wert ist eine ID in einer anderen Tabelle: folgen Sie ihr und benennen Sie die referenzierte Tabelle und ihre lesbare Spalte.
- Eine CHECK-Einschränkung. Eine auf eine Handvoll Literale eingeschränkte Spalte ist eine Aufzählung in allem außer dem Namen, und die Einschränkung nennt die erlaubte Menge explizit.
- Eine Nachschlagetabelle. Eine kleine Tabelle mit Code-und-Beschreibung-Zeilen, die über den Namen statt über einen deklarierten Schlüssel verknüpft ist, sehr verbreitet und wert, erkannt zu werden.
- Eine erweiterte Eigenschaft oder ein Spaltenkommentar - wo dein Team die Antwort schon aufgeschrieben hat und sie dir bisher niemand gezeigt hat.
Dokumentation als Nebenprodukt
Das Angenehme daran ist die Richtung, in die das geht: Du hättest das ohnehin nachgeschlagen, und die Notiz bedeutet, dass der nächste Person, sehr wahrscheinlich dein zukünftiges Ich, muss es nicht. Es ist derselbe Instinkt wie Schema dokumentieren, angewendet auf einen rätselhaften Wert nach dem anderen, anstatt auf eine ganze Datenbank auf einmal.
Geplant. Das Beziehungs- und Einschränkungsmodell, das es benötigt, existiert bereits und treibt bereits Join-Vorschlag und die Auflösung von Anzeige-Werten an.; das ist eine neue Oberfläche darüber, kein neues Wissen.