Files
jellybit/docs/conventions/database.md
T
av 42d5b73a04 docs: перевод документации на канон av-dev
- Раскладка docs/ приведена к канону 2: заведены passport/architecture/
  database/security/review и research; docs/specs, drafts, backlog, review/
  и BRIEF.md разобраны и удалены, беклог переехал в docs/tasks (34 задачи,
  6 целей, слаги на английский).
- Нарративы specs удалены как дубли openspec-спек после поимённой сверки;
  остаток заведён задачами (редактор маппинга ревью, крайние случаи
  именования), отказ от сущности title промоутнут в ADR.
- Проектные копии агентов и скиллов ревью/пайплайна удалены в пользу
  плагинов av-dev-pm и av-dev-pipeline; в task gate добавлен шаг canon
  вместо er-schema.
2026-08-04 09:27:26 +03:00

4.2 KiB

Конвенция: база данных и идентификаторы

Как мы устраиваем таблицы и ключи в SQLite. Актуальная схема — ../database.md; обоснование выбора ULID — openspec/changes/ulid-identity/design.md (после архивации — в истории git).

Механизировано: AUTOINCREMENT и DEFAULT (datetime('now')) в новых миграциях (internal/archrules), время мимо store.Now() (forbidigo).

Первичные ключи — ULID, не автоинкремент

  • PK сущности — TEXT ULID (26 символов Crockford base32), генерируется приложением в момент создания записи.
  • Почему ULID: сортируем по времени создания (ORDER BY id = хронология), компактен и удобен в URL/логах (без дефисов — grep и двойной клик берут id целиком), глобально уникален across таблиц — поиск по голому id находит все записи сущности в логах.
  • Единственная точка генерации и разбора — internal/ident: ident.NewID() при создании (в Create-методах store), ident.Parse() на входных границах. Никаких самодельных генераторов.

Канонический вид — lowercase

  • Генерим и храним id в нижнем регистре. Сравнение строк в SQLite побайтовое, поэтому любой внешний id (URL, форма, callback-data) ОБЯЗАТЕЛЬНО проходит ident.Parse до запроса к БД — он валидирует формат и нормализует регистр (base32 ULID case-insensitive при декодировании).
  • Синтаксически невалидный id трактуем как несуществующую сущность (404), без похода в БД.

Естественные и составные ключи — для деталей

  • У таблиц-деталей/связей допустим естественный или составной ключ вместо ULID, когда он есть по природе данных: download_infohash — PK (infohash, download_id), overrideUNIQUE(download_id, field). Отдельный ULID там — мёртвый вес.
  • Прочие генерируемые идентификаторы (например, apply_batch_id) — тоже через ident.NewID(): единый формат, сортируемость, корреляция в логах.

Прочее

  • Enum-поля (state, kind, …) — обычный TEXT без CHECK; допустимые значения держит код (internal/store).
  • Временные метки — TEXT в RFC 3339, UTC (суффикс Z), напр. 2006-01-02T15:04:05Z (секундная точность). Фиксированная ширина сохраняет лексикографическую сортировку TEXT = хронологию (ORDER BY created_at). Единая точка генерации — приложение: store.Now() + store.FormatTime/ ParseTime (аналогично ident.NewID для id), а не дефолт в схеме — так забытая вставка падает громко. Измерение длительности — не метка времени: у внешних вызовов его засекает logging.StartCall. Таймзона отображения в UI — конфиг [general].timezone.
  • Миграции — goose (internal/store/migrations): SQL-файлы для DDL; Go-миграции (goose.AddMigrationContext) — когда нужен код (генерация id, backfill). При изменении структуры обновляем ER-схему ../database.md в том же change.