SQLModel
Combine Pydantic 2 e SQLAlchemy para modelos amigáveis ao FastAPI.
Receita
Cartão de receita de referência rápida - pronto para copiar e colar.
from sqlmodel import Field, SQLModel
class Hero(SQLModel, table=True):
id: int | None = Field(default=None, primary_key=True)
name: strQuando usar isso:
- FastAPI CRUD
- Modelo de API/DB compartilhado
- Protótipos rápidos
Exemplo de Trabalho
with Session(engine) as session:
hero = Hero(name="Ada")
session.add(hero)
session.commit()O que isso demonstra:
- SQLModel table=True
- Uso de Sessão
- Compatibilidade com Pydantic
Mergulho Profundo
Como Funciona
- SQLModel herda de SQLAlchemy e Pydantic.
- Ainda use Alembic para migrações.
- Divida esquemas de leitura para APIs públicas quando necessário.
Armadilhas
- Validação de limite ignorada - Dados inválidos chegam às camadas de persistência. Correção: Valide com Pydantic ou formulários do framework na borda.
- Vazamento de traces de pilha - Clientes veem erros internos. Correção: Mapeie exceções para respostas HTTP estáveis.
- Bloqueio de loops de eventos assíncronos - Workers param sob carga concorrente. Correção: Use drivers assíncronos ou wrappers de threadpool.
- Segredos em controle de versão - Credenciais vazam pelo histórico do git. Correção: Carregue segredos de variáveis de ambiente ou de um cofre em tempo de execução.
- Falta de observabilidade - Incidentes são difíceis de depurar. Correção: Adicione logs estruturados, métricas e IDs de requisição.
Alternativas
| Alternativa | Use Quando | Não Use Quando |
|---|---|---|
| Framework alternativo neste cookbook | Padrão da equipe ou monólito existente | API Greenfield com restrições diferentes |
| BaaS Gerenciado | Apenas CRUD MVP | Autenticação personalizada, fluxos de trabalho ou necessidades de conformidade |
| gRPC | RPC interno de alto desempenho | Clientes HTTP públicos e acesso ao navegador |
FAQs
Quando devo adotar SQLModel?
Use-o quando os padrões e trade-offs nesta página corresponderem à sua API ou limite de dados.
Qual é o principal erro de produção com SQLModel?
Ignorar validação, timeouts ou contratos de erro explícitos na borda HTTP.
Como testar SQLModel?
Use o cliente de teste do framework, substitua dependências e afirme o status mais a forma JSON.
SQLModel funciona com Python 3.14?
Sim - exemplos visam Python 3.14 com versões de framework fixadas do rodapé da pilha.
Como SQLModel se relaciona com Pydantic 2?
Valide e serialize nas bordas; mantenha os serviços funcionando com objetos de domínio tipados.
Síncrono ou assíncrono?
Prefira rotas assíncronas quando I/O domina; mantenha o trabalho de CPU pequeno ou descarregue em workers.
Onde a lógica de negócios deve viver?
Handlers finos; serviços possuem regras; repositórios possuem consultas.
Como documentar APIs?
Publique documentação OpenAPI ou de esquema que corresponda aos modelos de resposta no código.
Como lidar com versionamento?
Versionamento explícito de URL ou cabeçalho com janelas de depreciação - evite quebras silenciosas.
O que devo ler a seguir?
Siga os links Relacionados para a próxima camada de profundidade nesta seção.
Como me manter seguro?
Autentique chamadores, autorize por recurso, limite a taxa e nunca registre segredos.
Primeiro passo para desempenho?
Meça a latência do DB e upstream antes de trocar de framework.
Relacionado
- Noções Básicas de Banco de Dados - Conexões e transações
- SQLAlchemy ORM 2.0 - Padrões ORM
- Migrações com Alembic - Mudanças de esquema
- Acesso Assíncrono a Banco de Dados - asyncpg
Versões da Pilha: Esta página foi escrita para Python 3.14.0 (estável 3.14, manutenção 3.13), FastAPI 0.115+, Django 5.2, Flask 3.1, Pydantic 2, PyTorch 2.6+, pandas 2.2+, Polars 1.x, ruff 0.9+, e uv 0.6+.