Template
Рефакторинг схемы
This commit is contained in:
@@ -0,0 +1,35 @@
|
||||
# Паттерн FR: таблица базы данных
|
||||
|
||||
Применяй паттерн, когда FR описывает структуру таблицы БД, а не SQL-команду её создания.
|
||||
|
||||
## Формат
|
||||
|
||||
Используй заголовок вида `<requirement-id>.FR-NN [DB]: Таблица хранения <имя>` и назови таблицу и схему приложения перед таблицей полей.
|
||||
|
||||
Таблицу полей оформляй с колонками в этом порядке:
|
||||
|
||||
| Поле | Тип | Ограничения и значение по умолчанию | Назначение |
|
||||
| --- | --- | --- | --- |
|
||||
| `field_name` | `TYPE` | NULL или NOT NULL; при наличии DEFAULT укажи значение | Короткое назначение поля |
|
||||
|
||||
Одна строка описывает одно поле. Указывай точный тип, nullability, default и ограничения, которые влияют на хранение или чтение данных. Называй назначение каждого поля. Не используй `—` или пустые ячейки вместо явного `NULL`, `NOT NULL` или отсутствия default.
|
||||
|
||||
После таблицы перечисляй только ограничения таблицы, которых нет в строках: первичный и внешние ключи, уникальность, индексы, порядок выборки и владение данными. Не дублируй значения по умолчанию или назначение полей. Пиши DDL только если конкретный контракт невозможно выразить этой таблицей.
|
||||
|
||||
## Пример
|
||||
|
||||
```markdown
|
||||
##### AREA.CAP-01.FR-01 [DB]: Таблица хранения записей
|
||||
|
||||
Таблица `example_records` создаётся в схеме приложения и содержит:
|
||||
|
||||
| Поле | Тип | Ограничения и значение по умолчанию | Назначение |
|
||||
| --- | --- | --- | --- |
|
||||
| `id` | `BIGINT` | identity, primary key, NOT NULL | Идентификатор строки |
|
||||
| `external_id` | `VARCHAR(64)` | NOT NULL | Идентификатор записи во внешней системе |
|
||||
| `status` | `VARCHAR(32)` | NOT NULL | Текущее состояние записи |
|
||||
| `created_at` | `TIMESTAMP` | NOT NULL | Время создания записи |
|
||||
| `updated_at` | `TIMESTAMP` | NULL | Время последнего изменения записи |
|
||||
|
||||
Индекс поддерживает выборку по `external_id` и `status`. Ограничение уникальности на `external_id` устанавливается, если внешняя система гарантирует его уникальность.
|
||||
```
|
||||
Reference in New Issue
Block a user