Peewee ORM 技术文档

1. 安装指南

安装 Peewee

Peewee 可以通过 pip 进行安装，支持 Python 2.7+ 和 3.4+ 版本。

pip install peewee

数据库驱动

根据你使用的数据库类型，安装相应的数据库驱动：

• SQLite: 内置于 Python 标准库，无需额外安装。
• MySQL/MariaDB: 安装 mysqlclient 或 pymysql。

  pip install mysqlclient
  

• PostgreSQL: 安装 psycopg2。

  pip install psycopg2
  

• CockroachDB: 安装 psycopg2。

  pip install psycopg2
  

2. 项目的使用说明

定义模型

Peewee 的模型定义类似于 Django 或 SQLAlchemy。以下是一个简单的模型定义示例：

from peewee import *
import datetime

db = SqliteDatabase('my_database.db')

class BaseModel(Model):
    class Meta:
        database = db

class User(BaseModel):
    username = CharField(unique=True)

class Tweet(BaseModel):
    user = ForeignKeyField(User, backref='tweets')
    message = TextField()
    created_date = DateTimeField(default=datetime.datetime.now)
    is_published = BooleanField(default=True)

连接数据库并创建表

连接到数据库并创建表：

db.connect()
db.create_tables([User, Tweet])

插入数据

创建几行数据：

charlie = User.create(username='charlie')
huey = User(username='huey')
huey.save()

Tweet.create(user=charlie, message='My first tweet')

查询数据

查询数据时，Peewee 提供了丰富的查询接口：

# 查询用户
User.get(User.username == 'charlie')

# 查询多个用户的推文
usernames = ['charlie', 'huey', 'mickey']
users = User.select().where(User.username.in_(usernames))
tweets = Tweet.select().where(Tweet.user.in_(users))

# 使用 JOIN 查询
tweets = (Tweet
          .select()
          .join(User)
          .where(User.username.in_(usernames)))

# 查询今天发布的推文数量
tweets_today = (Tweet
                .select()
                .where(
                    (Tweet.created_date >= datetime.date.today()) &
                    (Tweet.is_published == True))
                .count())

# 分页查询用户表
User.select().order_by(User.username).paginate(3, 20)

# 按推文数量排序用户
tweet_ct = fn.Count(Tweet.id)
users = (User
         .select(User, tweet_ct.alias('ct'))
         .join(Tweet, JOIN.LEFT_OUTER)
         .group_by(User)
         .order_by(tweet_ct.desc()))

3. 项目API使用文档

模型定义API

• Model: 所有模型的基类。
• CharField: 字符字段。
• TextField: 文本字段。
• DateTimeField: 日期时间字段。
• BooleanField: 布尔字段。
• ForeignKeyField: 外键字段。

查询API

• select(): 选择查询。
• where(): 条件查询。
• join(): 连接查询。
• count(): 计数查询。
• paginate(): 分页查询。
• update(): 更新查询。

数据库操作API

• connect(): 连接数据库。
• create_tables(): 创建表。
• save(): 保存数据。
• create(): 创建数据。

4. 项目安装方式

通过 pip 安装

Peewee 可以通过 pip 进行安装：

pip install peewee

从源码安装

你也可以从 GitHub 下载源码并进行安装：

git clone https://github.com/coleifer/peewee.git
cd peewee
python setup.py install

通过以上步骤，你可以轻松安装并使用 Peewee ORM 进行数据库操作。