cfircoo/claude-code-toolkit

sqlalchemy-postgres

Expert guidance for SQLAlchemy 2.0 + Pydantic + PostgreSQL.

查看源码

使用方法

  1. 复制安装命令,在自己的智能体环境安装前先检查源码包。
  2. 从原始文档核对所需工具、凭据和支持的宿主。
  3. 说明输入材料与期望交付物,并对照来源检查输出。
npx skills add https://github.com/cfircoo/claude-code-toolkit --skill sqlalchemy-postgres

开始前需了解

  • 安装不包含模型订阅、API 额度或访问文件的权限。
  • 仓库星数和安装量反映活跃情况,不等于独立质量或安全测试。
仓库原始内容

按源仓库内容呈现,保留标题、案例、代码、表格、链接以及原文引用的演示图片。

<essential_principles>

SQLAlchemy 2.0 + Pydantic + PostgreSQL Best Practices

This skill provides expert guidance for building production-ready database layers.

Stack

  • SQLAlchemy 2.0 with async support (asyncpg driver)
  • Pydantic v2 for validation and serialization
  • Alembic for migrations
  • PostgreSQL only

Core Principles

1. Separation of Concerns

models/       # SQLAlchemy ORM models (database layer)
schemas/      # Pydantic schemas (API layer)
repositories/ # Data access patterns
services/     # Business logic

2. Type Safety First Always use SQLAlchemy 2.0 style with Mapped[] type annotations:

python
from sqlalchemy.orm import Mapped, mapped_column

class User(Base):
    __tablename__ = "users"
    id: Mapped[int] = mapped_column(primary_key=True)
    name: Mapped[str] = mapped_column(String(100))

3. Async by Default Use async engine and sessions for FastAPI:

python
from sqlalchemy.ext.asyncio import create_async_engine, AsyncSession
engine = create_async_engine("postgresql+asyncpg://...")

4. Pydantic-SQLAlchemy Bridge Keep models and schemas separate but mappable:

python
# Schema reads from ORM
class UserRead(BaseModel):
    model_config = ConfigDict(from_attributes=True)

5. Repository Pattern Abstract database operations for testability and clean code. </essential_principles>

<intake> What do you need help with?

  1. Setup database layer - Initialize SQLAlchemy + Pydantic + Alembic from scratch
  2. Define models - Create SQLAlchemy models with Pydantic schemas
  3. Create migration - Generate and manage Alembic migrations
  4. Query patterns - Async CRUD, joins, eager loading, optimization
  5. Full implementation - Complete database layer for a feature

</intake>

<routing>

ResponseWorkflow
1, "setup", "initialize", "start"workflows/setup-database.md
2, "model", "define", "create model"workflows/define-models.md
3, "migration", "alembic", "schema change"workflows/create-migration.md
4, "query", "crud", "repository"workflows/query-patterns.md
5, "full", "complete", "feature"Run setup → define-models → create-migration

Auto-detection triggers (use this skill when user mentions):

  • database, db, sqlalchemy, postgres, postgresql
  • model, migration, alembic
  • repository, crud, query
  • async session, connection pool

</routing>

<reference_index>

Domain Knowledge

ReferencePurpose
references/best-practices.mdProduction patterns, security, performance
references/patterns.mdRepository, Unit of Work, common queries
references/async-patterns.mdAsync session management, FastAPI integration

</reference_index>

<workflows_index>

WorkflowPurpose
workflows/setup-database.mdInitialize complete database layer
workflows/define-models.mdCreate models + schemas + relationships
workflows/create-migration.mdAlembic migration workflow
workflows/query-patterns.mdCRUD operations and optimization

</workflows_index>

<quick_reference>

File Structure

src/
├── db/
│   ├── __init__.py
│   ├── base.py          # DeclarativeBase
│   ├── session.py       # Engine + async session factory
│   └── dependencies.py  # FastAPI dependency
├── models/
│   ├── __init__.py
│   └── user.py          # SQLAlchemy models
├── schemas/
│   ├── __init__.py
│   └── user.py          # Pydantic schemas
├── repositories/
│   ├── __init__.py
│   ├── base.py          # Generic repository
│   └── user.py          # User repository
└── alembic/
    ├── alembic.ini
    ├── env.py
    └── versions/

Essential Imports

python
# Models
from sqlalchemy import String, Integer, ForeignKey, DateTime
from sqlalchemy.orm import Mapped, mapped_column, relationship, DeclarativeBase

# Async
from sqlalchemy.ext.asyncio import create_async_engine, AsyncSession, async_sessionmaker

# Pydantic
from pydantic import BaseModel, ConfigDict, Field

Connection String

python
# PostgreSQL async
DATABASE_URL = "postgresql+asyncpg://user:pass@localhost:5432/dbname"

</quick_reference>

<success_criteria> Database layer is complete when:

  • [ ] Async engine and session factory configured
  • [ ] Base model with common fields (id, createdat, updatedat)
  • [ ] Models use Mapped[] type annotations
  • [ ] Pydantic schemas with from_attributes=True
  • [ ] Alembic configured for async
  • [ ] Repository pattern implemented
  • [ ] FastAPI dependency for session injection
  • [ ] Connection pooling configured for production

</success_criteria>

按任务相关推荐