Pular para conteúdo

Template: Tabela DB

Objetivo

Padronizar a documentação de uma tabela real do PostgreSQL — baseado no formato usado em Database do CoreFlow CRM.


Estrutura

# Tabela: `<nome_da_tabela>`

Model: `apps.<modulo>.<NomeDaEntidade>`

## Colunas

| Coluna | Tipo PostgreSQL | Nulo | Default | Descrição |
|---|---|---|---|---|
| id | uuid | não | `uuid4()` | Chave primária (via `BaseModel`) |
| ... | ... | ... | ... | ... |

## Chaves estrangeiras

| Coluna | Referencia | `on_delete` |
|---|---|---|
| ... | `<tabela>.id` | ... |

## Índices

| Índice | Colunas | Motivo |
|---|---|---|
| ... | ... | filtro frequente / join / unicidade |

## Constraints

- `unique_together`/`UniqueConstraint` reais
- `check` constraints reais

Regra de preenchimento

Gerar a partir do models.py real (makemigrations --dry-run ajuda a conferir o SQL gerado) — nunca do modelo "ideal". Ver regra 08 do padrão de codificação: nunca gerar migração nova só para documentar.


Referências