3.0 KiB
Паттерн FR: таблица базы данных
Применяй паттерн, когда FR описывает структуру таблицы БД, а не SQL-команду её создания.
Формат
Используй заголовок вида <requirement-id>.FR-NN [DB]: Таблица хранения <имя> и назови таблицу и схему приложения перед таблицей полей.
Таблицу полей оформляй с колонками в этом порядке:
| Поле | Тип | Ограничения и значение по умолчанию | Назначение |
|---|---|---|---|
field_name |
TYPE |
NULL или NOT NULL; при наличии DEFAULT укажи значение | Короткое назначение поля |
Одна строка описывает одно поле. Указывай точный тип, nullability, default и ограничения, которые влияют на хранение или чтение данных. Называй назначение каждого поля. Не используй — или пустые ячейки вместо явного NULL, NOT NULL или отсутствия default.
После таблицы перечисляй только ограничения таблицы, которых нет в строках: первичный и внешние ключи, уникальность, индексы, порядок выборки и владение данными. Не дублируй значения по умолчанию или назначение полей. Пиши DDL только если конкретный контракт невозможно выразить этой таблицей.
Пример
##### CFG.AS-01.FR-01 [DB]: Таблица хранения settings
Таблица `settings` создаётся в схеме приложения и содержит:
| Поле | Тип | Ограничения и значение по умолчанию | Назначение |
| --- | --- | --- | --- |
| `id` | `BIGINT` | identity, primary key, NOT NULL | Идентификатор строки |
| `config_key` | `VARCHAR(128)` | NULL | Область или сущность приложения |
| `setting_key` | `VARCHAR(128)` | NOT NULL | Имя настройки |
| `setting_value` | `TEXT` | NOT NULL | Текстовое значение настройки |
| `sort_order` | `INT` | NOT NULL, DEFAULT 0 | Порядок повторяющихся ключей |
| `is_enabled` | `BOOLEAN` | NOT NULL, DEFAULT TRUE | Признак участия записи в чтении |
| `description` | `TEXT` | NULL | Пояснение к настройке |
Индексы поддерживают выборку по `setting_key`, `config_key`, `is_enabled` и порядок `sort_order`, `id`. Ограничение уникальности на `setting_key` не устанавливается.