Правило, которое проверяет машина, не должно оставаться прозой: файл конвенций на сотни строк размазывает внимание по тривиальному — модель добросовестно проверит именование полей лога и не дойдёт до формы решения. Включены sloglint (константный msg, стиль ключ-значение), forbidigo (fmt.Print*, os.Getenv, time.Now мимо store.Now), errorlint (сравнение ошибок), depguard (сторонние пакеты ошибок). internal/archrules — сканеры на то, что линтером не выражается: направление зависимостей ядро↔транспорты, AUTOINCREMENT и серверное время в новых миграциях, матчинг ошибки по тексту. Код приведён к правилам: logging.StartCall как единая точка отсчёта длительности внешних вызовов, store.Now вместо time.Now в httpapi и часах воркера, slog.DiscardHandler в тестах. Перенесённое вычеркнуто из docs/conventions/* и openspec/config.yaml — прозой осталось только то, что правилом не выражается. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
4.3 KiB
4.3 KiB
Конвенция: база данных и идентификаторы
Как мы устраиваем таблицы и ключи в SQLite. Актуальная схема —
../specs/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),override—UNIQUE(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), а не дефолт в схеме — так забытая вставка падает громко (NOT NULLбез дефолта). Измерение длительности — не метка времени: для внешних вызовов его засекаетlogging.StartCall. Зона хранения всегда UTC; таймзона отображения в UI — конфиг[general].timezone. - Миграции — goose (
internal/store/migrations): SQL-файлы для DDL; Go-миграции (goose.AddMigrationContext) — когда нужен код (генерация id, backfill). При изменении структуры обновляем ER-схему ../specs/database.md в том же change.