Pular para conteúdo

Template: Entidade

Objetivo

Padronizar a documentação de uma entidade (model Django) individual — baseado no formato real usado em Database do CoreFlow CRM.

Estrutura

# <NomeDaEntidade>

App: `apps.<modulo>` — model `<NomeDaEntidade>`

## Campos

| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| id | UUID (herdado de BaseModel) | sim | Chave primária |
| ... | ... | ... | ... |

## Relacionamentos

| Campo | Tipo de relação | Entidade relacionada | `on_delete` |
|---|---|---|---|
| ... | ForeignKey/OneToOne/ManyToMany | ... | ... |

## Validações e constraints

- Regras de `clean()` real do model
- `Meta.constraints` / `unique_together` reais

## Índices

Campos indexados no model real e o motivo (filtro frequente, join).

## Exclusão lógica

Se herda `BaseModel`: usa `is_active`. Se não: descrever o comportamento real de exclusão.

## Auditoria

Ações desta entidade que geram `AuditLog` (Log Duplo — banco + sistema), com os códigos de ação usados (4=Inclusão, 3=Alteração, 5=Exclusão).

Regra de preenchimento

Toda linha vem do models.py real — copiar field.help_text/tipos exatamente como declarados, não inferir. Campos e relacionamentos que não existem não entram na tabela.

Referências