peewee Documentation Release 3.0.0

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

摘要

The document provides a comprehensive overview of Peewee, a lightweight and simple ORM for Python. It supports SQLite, MySQL, and PostgreSQL, with additional extensions available. The guide covers model definition, data storage and retrieval, database configuration, transaction management, error handling, and query logging. It also includes information on installation, usage with Flask, and contributing to the project.

AI总结

### Peewee ORM 文档总结

#### 1. **简介**
- **Peewee** 是一个简单且轻量级的 ORM（对象关系映射）框架，支持 Python 2.7+ 和 3.2+。
- 核心特点：
- 少而精的概念，易于学习和使用。
- 内置支持 SQLite、MySQL 和 PostgreSQL。
- 提供丰富的扩展模块（如 Postgres 的 JSON、数组、全文检索等）。

#### 2. **核心功能**
- **模型定义**：
- 模型类对应数据库表，字段对应表中的列，模型实例对应表中的记录。
- 示例：

    from peewee import *
    db = SQLiteDatabase('people.db')
    class Person(Model):
        name = CharField()
        age = IntegerField()

- **数据操作**：
- 支持增删改查操作，代码简洁直观。
- 提供事务管理（`atomic()`）、显式事务（`transaction()`）和保存点（`savepoint()`）功能。

#### 3. **数据库支持**
- **内置数据库**：
- SQLite：支持 WAL 模式和缓存配置。
- MySQL：支持网络连接配置。
- PostgreSQL：支持扩展功能（如 hstore、JSON 等）。
- **扩展模块**：
- `playhouse.sqlite_ext`：增强 SQLite 功能（如 REGEXP 支持）。
- `playhouse.postgres_ext`：扩展 PostgreSQL 功能。

#### 4. **高级特性**
- **查询优化**：
- 支持避免 N+1 查询、批量插入和全文检索。
- **事务管理**：
- 提供原子操作（`atomic()`）和显式事务控制。
- 支持嵌套事务和回滚点。
- **日志记录**：
- 所有查询记录到 `peewee` 日志命名空间，使用 DEBUG 级别。

#### 5. **安装与使用**
- **安装**：
- 通过 PyPI 安装：`pip install peewee`。
- 通过 Git 克隆：`git clone https://github.com/coleifer/peewee.git`。
- **快速入门**：
- 推荐阅读《Quickstart Guide》和《Guide to Query Operators》。
- 提供交互式 shell 用于快速上手。

#### 6. **扩展与贡献**
- **Playhouse**：
- 提供额外功能模块，如 Flask 插件、数据集支持等。
- **社区贡献**：
- 欢迎提交代码、报告问题或参与讨论。
- 提交补丁需包含单元测试和文档。

#### 7. **总结**
Peewee 是一个高效、灵活且易于上手的 ORM 框架，适合快速开发数据库驱动的应用程序。其简洁的设计和丰富的扩展功能使其在中小型项目中尤为适合。