peewee Documentation Release 3.4.0

• 语言: 英语
• 格式: .pdf
• 来源: docs.peewee-orm.com

摘要

Peewee是一个简单且功能强大的Python ORM框架，支持SQLite、MySQL和PostgreSQL等数据库。文档详细介绍了Peewee的核心功能，包括模型定义、查询构建、数据库连接管理以及高级特性如递归CTE查询、查询构建器、扩展模块和数据导出导入功能。Peewee以其简洁易用的API和强大的扩展性著称，适合快速开发和维护数据库驱动的应用。

AI总结

《peewee Documentation Release 3.4.0》文档总结：

1. **核心功能**
- **Peewee简介**：Peewee是一个简单且高度表达化的ORM（对象关系映射器），支持Python 2.7+和3.4+，适用于快速开发。
- **数据库支持**：内置支持SQLite、MySQL和PostgreSQL，提供针对后者的高级扩展模块。
- **核心特性**：
- 少而精的概念设计，易于学习和使用。
- 支持复杂的查询操作，包括联合查询（UNION）、交集（INTERSECT）、差集（EXCEPT）等。
- 提供丰富的字段类型和扩展功能（如PostgreSQL的JSON、数组支持，SQLite的全文搜索等）。

2. **数据库连接与配置**
- **数据库对象**：通过`Database`类创建数据库连接，支持打开/关闭连接、执行查询、事务管理等功能。
- **示例配置**：
- SQLite：`SqliteDatabase('/path/to/app.db', pragmas=(('journal_mode', 'wal'), ('cache_size', -1024 * 64)))`
- MySQL：`MySQLDatabase('my_app', user='app', password='db_password', host='10.1.0.8', port=3316)`
- PostgreSQL：`PostgresqlDatabase('my_app', user='postgres', password='secret', host='10.1.0.9', port=5432)`

3. **高级查询功能**
- **CTE（公共表表达式）**：支持递归查询，用于复杂数据关系的处理。
- **查询构建**：
- 支持联合查询（`UNION`/`UNION ALL`）、交集（`INTERSECT`）、差集（`EXCEPT`）。
- 提供`SelectQuery`类，支持操作符重载，便于构建复杂查询。
- **分页功能**：通过`PaginatedQuery`实现基于GET参数的分页，支持自定义分页大小和页面检查。

4. **扩展功能（Playhouse模块）**
- **数据导入/导出**：
- `freeze()`：将查询结果导出为CSV或JSON格式。
- `thaw()`：将数据导入指定表中，支持严格模式。
- **表操作**：
- `create_index()`：创建索引。
- `insert()`/`replace()`/`update()`/`delete()`：支持基本的CRUD操作。
- **模式迁移**：支持数据库模式的版本控制和迁移。

5. **高级功能**
- **Upsert（插入或更新）**：
- 支持多种数据库的`INSERT ON CONFLICT`语法。
- PostgreSQL支持更细粒度的冲突处理，包括指定约束目标、保留或更新特定字段。
- **查询优化**：
- `peek()`：预览查询结果。
- `first()`：获取第一条记录。
- `scalar()`：获取查询结果中的单个值。

6. **实用工具**
- **模型转换**：`model_to_dict()`函数支持将模型实例转换为字典，便于数据序列化。
- **API文档**：提供详细的查询构建和API接口文档，便于开发者快速上手。

总结：Peewee是一个功能强大且易于使用的ORM工具，适合快速开发数据库驱动的应用程序，尤其在处理复杂查询和分页时表现出色。其扩展模块Playhouse进一步增强了其功能，支持更多高级数据库操作和数据处理任务。