Документация по автомагическим строкам

запланировано

Отслеживайте необъяснимое значение через DDL и оставляйте полезную заметку для следующего человека, возможно, для будущего себя.

Нашли в результатах загадочный код? Когда SQLly может проследить значение через Инспекция DDL, он оставляет встроенную заметку о том, откуда взялось значение, — так запрос заодно отвечает ещё на один свой вопрос.

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

Откуда берется объяснение

Из схемы, в порядке убывания надежности — и в примечании указано, какой вариант использован:

  1. Внешний ключ. Значение — идентификатор в другой таблице: пройдите по нему и назовите таблицу, на которую он ссылается, и её человекочитаемый столбец.
  2. Ограничение проверки. Столбец, ограниченный несколькими литеральными значениями, во всём, кроме названия, является перечислением, и ограничение задаёт допустимый набор.
  3. Справочная таблица. Небольшая таблица строк вида «код и описание», связанная по имени, а не по объявленному ключу; встречается очень часто, и стоит научиться её узнавать.
  4. Расширенное свойство или комментарий к столбцу - где ваша команда уже написала ответ, и вам никто его не показывал.
Примечание — это комментарий, никогда не переписывание. Пояснение вставляется SQL-комментарием, поэтому в остальном оно инертно, переживает коммит в репозиторий и стирается одним нажатием клавиши. Ваш запрос означает ровно то же, что и прежде.

Документация как побочный продукт

Приятная часть — куда всё движется: вы всё равно собирались это выяснить, и заметка означает, что следующий человек — вполне возможно, будущий вы — не должен этого делать. Это тот же инстинкт, что и Документирование схемы, применяемый к одному загадочному значению за раз, а не ко всей базе данных сразу.

Запланировано. Нужная модель связей и ограничений уже существует и уже лежит в основе предложение соединения и определение отображаемого значения; это новая надстройка поверх неё, а не новые знания.