peewee Documentation Release 3.6.0

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

摘要

The document introduces the release of Peewee ORM version 3.6.0, highlighting its features, updates, and compatibility. It covers the ORM's support for SQLite, MySQL, and PostgreSQL, including specific extensions and improvements. Key updates include changes to the query-builder, virtual-table implementation, and database connection handling. The document also details changes in database and model meta options, as well as deprecated features. It provides information on installation, testing, and usage, along with extensions like Playhouse for additional functionality.

AI总结

### Peewee Documentation Release 3.6.0 总结

#### 1. **Peewee简介**
- **Peewee** 是一个简单且小型的ORM（对象关系映射器），易于学习和使用。
- 支持的Python版本：2.7+ 和 3.4+（主要开发于3.6）。
- 支持的数据库：SQLite、MySQL 和 PostgreSQL。
- 提供了丰富的扩展功能。

#### 2. **新功能与改进**
##### 2.1 查询构建器
- 查询构建器完全重写，更具灵活性和强大功能。
- 提供了一个通用的低级API用于构造查询。

##### 2.2 SQLite支持
- 将`sqlite_ext`模块中的功能整合到Peewee核心：
- 支持用户定义的函数、聚合、排序规则和表函数。
- 支持加载扩展、指定pragma等。
- 新增功能：
- 支持SQLite在线备份API。
- 支持BloomFilter、Incremental Blob I/O、LSMTable等。
- 提供了多个用户定义的哈希和排名函数。

##### 2.3 PostgreSQL扩展
- `PostgresqlExtDatabase`不再默认注册`hstore`扩展。如需使用，需在初始化时设置`register_hstore=True`。

##### 2.4 模型与字段变更
- **模型元选项**：
- `db_table`改为`table_name`。
- `db_table_func`改为`table_function`。
- �移除`order_by`和`validate_backrefs`。
- **模型类**：
- `BaseModel`重命名为`ModelBase`。
- `model_class`改为`model`。
- **字段**：
- `db_column`改为`column_name`。
- `PrimaryKeyField`重命名为`AutoField`。
- `ForeignKeyField`参数调整：
- `rel_model`改为`model`。
- `to_field`改为`field`。
- `related_name`改为`backref`。
- 移除了`PasswordField`、`PickledField`和`AESEncryptedField`。

#### 3. **其他改进**
- **兼容性**：
- 部分API发生变化，可能会触发`DeprecationWarning`。
- `create_table`和`drop_table`默认启用`safe`模式（创建时若不存在则创建，删除时若存在则删除）。
- **安装与测试**：
- 可通过PyPI安装：`pip install peewee`。
- 提供C扩展（需Cython支持）以提高性能。

#### 4. **示例与资源**
- 提供了多个示例和文档帮助：
- Quickstart指南。
- 示例Twitter应用。
- 模型、查询和关系的详细说明。

#### 5. **扩展与工具**
- **Playhouse扩展**：
- 提供了额外的功能和工具。
- **文档**：
- 提供了详细的“Using SQLite”和“SQLite extensions”文档。

#### 6. **总结**
Peewee 3.6.0版本对查询构建器、数据库支持和模型功能进行了重大改进，同时移除了部分旧功能并调整了API。开发者应关注这些变化以确保代码兼容性，并参考文档和示例快速上手。