菜单
YWeb ORM 使用规范。在编写数据库模型定义、CRUD 操作、查询过滤、分页、软删除、事务管理、批量操作、关系定义等数据层代码时使用。基于 SQLAlchemy 的 Active Record 模式。
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
| name | yweb-orm |
| description | YWeb ORM 使用规范。在编写数据库模型定义、CRUD 操作、查询过滤、分页、软删除、事务管理、批量操作、关系定义等数据层代码时使用。基于 SQLAlchemy 的 Active Record 模式。 |
YWeb ORM 基于 SQLAlchemy，采用 Active Record 模式：
BaseModel（自动获得 id/name/code/时间戳/软删除等字段）CoreModel（仅 id + 时间戳，更轻量）init_database() 一行初始化Model.query 进行链式查询comment：mapped_column(String(255), comment="字段说明")Mapped[str] 类型注解 + mapped_column()__tablename__BaseModel 自带软删除支持，查询自动过滤已删除记录@transactional 装饰器管理事务边界编码时根据需要阅读对应文档：
| 文档路径 | 说明 |
|---|---|
yweb-core/docs/03_orm_guide.md | ORM 基础指南（初始化、模型定义、CRUD、分页、软删除） |
yweb-core/docs/orm_docs/README.md | ORM 完整功能文档索引 |
| 文档路径 | 说明 |
|---|---|
yweb-core/docs/orm_docs/01_overview.md | 概述与架构设计 |
yweb-core/docs/orm_docs/02_model_definition.md | 模型定义（BaseModel、CoreModel、字段） |
yweb-core/docs/orm_docs/03_crud_operations.md | CRUD 操作（save/add/update/delete） |
yweb-core/docs/orm_docs/03_relationships.md | 关系定义（一对一/一对多/多对多/自关联） |
yweb-core/docs/orm_docs/04_query_and_filter.md | 查询与过滤（Query 对象、链式调用） |
yweb-core/docs/orm_docs/05_pagination.md | 分页查询（Page 对象） |
yweb-core/docs/orm_docs/06_bulk_operations.md | 批量操作 |
| 文档路径 | 说明 |
|---|---|
yweb-core/docs/orm_docs/07_soft_delete.md | 软删除机制 |
yweb-core/docs/orm_docs/08_cascade_soft_delete.md | 级联软删除 |
yweb-core/docs/orm_docs/09_version_control.md | 乐观锁与版本控制 |
yweb-core/docs/orm_docs/10_history.md | 历史记录 |
yweb-core/docs/orm_docs/11_transaction.md | 事务管理 |
yweb-core/docs/orm_docs/12_db_session.md | 数据库会话管理 |
yweb-core/docs/orm_docs/16_transaction_manager.md | 高级事务管理器（嵌套事务、Savepoints） |
| 文档路径 | 说明 |
|---|---|
yweb-core/docs/orm_docs/13_serialization.md | 数据序列化（to_dict） |
yweb-core/docs/orm_docs/14_schema_validation.md | Schema 与验证 |
yweb-core/docs/orm_docs/15_fastapi_integration.md | FastAPI 集成 |
| 文档路径 | 说明 |
|---|---|
yweb-core/docs/orm_docs/21_owns_one.md | OwnsOne 值对象嵌入（OwnedType 定义、查询代理、嵌套/平铺序列化） |
| 文档路径 | 说明 |
|---|---|
yweb-core/docs/orm_docs/17-tree-structure-guide.md | 树形结构混入 |
yweb-core/docs/orm_docs/18-sortable-mixin-guide.md | 排序混入 |
yweb-core/docs/orm_docs/19-state-machine-guide.md | 状态机混入 |
yweb-core/docs/orm_docs/20-taggable-mixin-guide.md | 标签混入 |
| 文档路径 | 说明 |
|---|---|
yweb-core/docs/orm_commit_behavior_outside_transaction.md | 事务外提交行为 |
yweb-core/docs/orm_commit_suppression_mechanism.md | 提交抑制机制 |
02_model_definition.md03_crud_operations.md11_transaction.md 和 16_transaction_manager.md21_owns_one.md03_orm_guide.md 基础指南开始基于 SOC 职业分类
YWeb 基础设施模块规范。在使用缓存（@cached）、异常处理（Err/register_exception_handlers）、日志（get_logger）、配置（AppSettings/YAML）、文件存储（本地/OSS/S3）、定时任务（Scheduler）、限流（setup_ratelimit）时使用。
YWeb DDD 分层架构与 API 设计规范。在创建或修改 API 路由、Service 层、领域模型、DTO 时使用。涵盖瘦 API 原则、服务层拆分、Model 设计、DTO 转换、响应格式等。
YWeb 认证授权与权限管理规范。在实现用户登录、JWT Token 处理、权限校验、角色管理、组织架构、OAuth 集成等功能时使用。
YWeb 框架编码总规范。基于 FastAPI + SQLAlchemy 的 Web 框架，采用 Active Record + DDD 分层架构。在编写任何基于 yweb 框架的代码时使用此技能，包括 API 开发、ORM 操作、认证授权、缓存、异常处理等场景。
审查和改进 pytest 测试的真实性，防止 Happy Path、浅层、实现驱动、同义反复等虚假测试；在测试失败时执行先诊断后改码流程。用于测试评审、测试重构、失败排查场景。
YWeb 框架 Pytest 单元测试编写规范。适用于 yweb-core 底层框架本身，以及通过 pip install yweb 安装后基于该框架开发的任何上层应用。涵盖测试目录结构、conftest 编写、fixture 模式、ORM 测试、API 测试、Service 测试、Domain 测试、Mock 策略、异步测试等场景。
