12 lines
723 B
Markdown
12 lines
723 B
Markdown
# DB Usage Rules
|
|
|
|
## Что описывать
|
|
- какие API / logic block / batch job используют таблицу;
|
|
- какие операции выполняются: read / insert / update / delete;
|
|
- как таблица участвует в пользовательском сценарии.
|
|
|
|
## Правила
|
|
- ссылки на связанные документы давать по `doc_id` или path;
|
|
- не дублировать полный use case, а показывать роль таблицы в сценарии;
|
|
- если таблица используется для пагинации, фильтрации или сортировки, это нужно отметить явно.
|