美文网首页
peewee用法考察

peewee用法考察

作者: yuchanns | 来源:发表于2018-12-13 16:58 被阅读232次

    [TOC]


    peewee

    最近尝试使用tornado。由于tornado组件较为简洁,还需引入一些其他类库结合使用。在ORM方面,我选择了轻量小巧的peewee。本文即对peewee的用法进行初步考察,记录自用。

    阅读原文体验更佳

    主要参考内容:
    peewee官方文档

    考察目标

    peewee支持多种数据库,而本文的考察环境是mysql,存储引擎为InnoDB。
    常用的sql操作可简单分为CURD。我平常工作使用的功能细分如下:

    • Create:单条插入、批量插入、批量块插入、获取自增pk
    • Update:数据更新
    • Retrieve:单条查询、多条查询、指定字段单条/多条查询、关联查询(join、union)、聚合查询
    • Delete:单条删除、批量删除
    • 其他功能:事务、原生sql查询

    前置准备

    在mysql中新建表

    本文使用数据库名为peewee,三张表分别是user、balance和integral,结构如下:

    CREATE TABLE `user` (
      `uid` int(11) NOT NULL AUTO_INCREMENT COMMENT '用户编号',
      `avartar` varchar(200) NOT NULL COMMENT '头像',
      `uname` varchar(50) NOT NULL COMMENT '用户名',
      `gender` char(1) NOT NULL DEFAULT '0' COMMENT '性别 0-保密|1-男|2-女',
      `password` varchar(200) NOT NULL COMMENT '密码',
      `balance` decimal(10,2) NOT NULL DEFAULT '0.00' COMMENT '余额',
      `integral` int(11) NOT NULL DEFAULT '0' COMMENT '积分',
      `logintime` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '最后登录时间',
      `addtime` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '注册时间',
      PRIMARY KEY (`uid`),
      UNIQUE KEY `uname` (`uname`) COMMENT '用户名唯一'
    ) ENGINE=InnoDB AUTO_INCREMENT=10000 DEFAULT CHARSET=utf8 COMMENT='用户信息'
    
    CREATE TABLE `balance` (
      `b_id` int(11) NOT NULL AUTO_INCREMENT COMMENT '操作编号',
      `uid` int(11) NOT NULL DEFAULT '0' COMMENT '用户编号',
      `change` decimal(10,2) NOT NULL DEFAULT '0.00' COMMENT '变动金额',
      `total` decimal(10,2) NOT NULL DEFAULT '0.00' COMMENT '剩余金额',
      `addtime` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '操作时间',
      PRIMARY KEY (`b_id`),
      KEY `uid` (`uid`) COMMENT '用户编号'
    ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='余额操作记录表'
    
    CREATE TABLE `integral` (
      `i_id` int(11) NOT NULL AUTO_INCREMENT COMMENT '操作编号',
      `uid` int(11) NOT NULL DEFAULT '0' COMMENT '用户编号',
      `change` decimal(10,2) NOT NULL DEFAULT '0.00' COMMENT '变动积分',
      `total` decimal(10,2) NOT NULL DEFAULT '0.00' COMMENT '剩余积分',
      `addtime` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '操作时间',
      PRIMARY KEY (`i_id`),
      KEY `uid` (`uid`) COMMENT '用户编号'
    ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='积分操作记录表'
    

    python连接mysql,需要pymysql或mysql-connector-python。

    pip install pymysql peewee
    

    生成映射模型

    peewee分别提供根据模型生成表根据表生成模型的功能。但peewee等orm要考虑兼容多种数据库,因此模型生成表的过程中只能使用所有数据库公有的字段类型,不能使用mysql的tinyint、char等类型,所以不考虑根据模型生成表。使用pwiz命令生成模型:

    python -m pwiz -e mysql -H localhost -p3306 -uroot -P peewee > models.py
    

    获得以下model文件:

    # -*- coding: utf-8 -*-
    # models.py
    
    from peewee import *
    
    database = MySQLDatabase('peewee', **{'charset': 'utf8', 'use_unicode': True, 'host': 'localhost', 'port': 3306, 'user': 'root', 'password': ''})
    
    
    class UnknownField(object):
        def __init__(self, *_, **__): pass
    
    
    class BaseModel(Model):
        class Meta:
            database = database
    
    
    class Balance(BaseModel):
        addtime = DateTimeField(constraints=[SQL("DEFAULT CURRENT_TIMESTAMP")])
        b = AutoField(column_name='b_id')
        change = DecimalField(constraints=[SQL("DEFAULT 0.00")])
        total = DecimalField(constraints=[SQL("DEFAULT 0.00")])
        uid = IntegerField(constraints=[SQL("DEFAULT 0")], index=True)
    
        class Meta:
            table_name = 'balance'
    
    
    class Integral(BaseModel):
        addtime = DateTimeField(constraints=[SQL("DEFAULT CURRENT_TIMESTAMP")])
        change = DecimalField(constraints=[SQL("DEFAULT 0.00")])
        i = AutoField(column_name='i_id')
        total = DecimalField(constraints=[SQL("DEFAULT 0.00")])
        uid = IntegerField(constraints=[SQL("DEFAULT 0")], index=True)
    
        class Meta:
            table_name = 'integral'
    
    
    class User(BaseModel):
        addtime = DateTimeField(constraints=[SQL("DEFAULT CURRENT_TIMESTAMP")])
        avartar = CharField()
        balance = DecimalField(constraints=[SQL("DEFAULT 0.00")])
        gender = CharField(constraints=[SQL("DEFAULT '0'")])
        integral = IntegerField(constraints=[SQL("DEFAULT 0")])
        logintime = DateTimeField(constraints=[SQL("DEFAULT CURRENT_TIMESTAMP")])
        password = CharField()
        uid = AutoField()
        uname = CharField(unique=True)
    
        class Meta:
            table_name = 'user'
    

    Create

    新建一个peewee_test.py文件,引入models,使用logging类库观察执行的sql语句。

    第一种添加方法

    # -*- coding: utf-8 -*-
    # peewee_test.py
    
    from models import *
    import sys, logging, hashlib
    
    # 使用日志观察执行的sql语句
    logger = logging.getLogger('peewee')
    logger.setLevel(logging.DEBUG)
    logger.addHandler(logging.StreamHandler())
    
    
    def create():
        """md5加密密码"""
        m = hashlib.md5()
        m.update('123456'.encode())
        pwd = m.hexdigest()
        """头像"""
        avartar = 'https://avatars2.githubusercontent.com/u/25029451'
        """第一种添加方法"""
        user = User(
            avartar=avartar, 
            uname='John', gender='1', password=pwd
        )
        uid = user.save()
        print('uid=%d' % uid)
    
    
    if __name__ == '__main__':
        sys.exit(create())
    
    

    运行peewee_test.py,查看控制台输出信息,我们得知第一种添加方法不会返回插入的自增pk(此时自增pk为uid=10000),而是成功返回1,失败返回0;

    python peewee_test.py
    ('INSERT INTO `user` (`avartar`, `gender`, `password`, `uname`) VALUES (%s, %s, %s, %s)', ['https://avatars2.githubusercontent.com/u/25029451', '1', 'e10adc3949ba59abbe56e057f20f883e', 'John'])
    uid=1
    
    Process finished with exit code 0
    

    第二种添加方法

    def create():
        """第二种添加方法"""
        uid = User.create(
            avartar=avartar,
            uname='Jack', gender='1', password=pwd
        )
        print('uid=%s' % uid)
    

    注意第二种方法中我打印uid使用格式化操作符是%s而不是%d,因为返回值是一个User对象
    查看控制台输出信息,可知第二种方法会返回自增pk;

    python peewee_test.py
    ('INSERT INTO `user` (`avartar`, `gender`, `password`, `uname`) VALUES (%s, %s, %s, %s)', ['https://avatars2.githubusercontent.com/u/25029451', '1', 'e10adc3949ba59abbe56e057f20f883e', 'Jack'])
    uid=10001
    
    Process finished with exit code 0
    

    第三种添加方法

    def create():
        """第三种添加方法"""
        uid = User.insert(
            avartar=avartar,
            uname='Micheal', gender='1', password=pwd
        ).execute()
        print('uid=%d' % uid)
    

    查看控制台输出信息,第三种方法也会返回自增pk。

    python peewee_test.py
    ('INSERT INTO `user` (`avartar`, `gender`, `password`, `uname`) VALUES (%s, %s, %s, %s)', ['https://avatars2.githubusercontent.com/u/25029451', '1', 'e10adc3949ba59abbe56e057f20f883e', 'Micheal'])
    uid=10002
    
    Process finished with exit code 0
    

    第一种需要调用save()方法才能插入数据,而第二种不需要调用其他方法,第三种则调用execute()方法进行插入。第二种方法返回的是对象,第三种方法返回的是整型。工作中我经常需要在后续代码中使用到自增pk,因此我将采用insert()方法进行添加操作。

    批量添加方法

    使用insert_many批量添加数据:在插入多条数据时,根据文档描述,create()方法每次都会开启事务(如果存储引擎支持),虽然可以遍历方式用上述方法逐条插入,但数据量一大就会导致效率低下,所以有必要进行批量插入优化。

    If you are not wrapping the loop in a transaction then each call to create() happens in its own transaction. That is going to be really slow!

    def create():
        """批量添加数据"""
        data_source = [
            (avartar, 'Catherine', '2', pwd),
            (avartar, 'Jane', '2', pwd),
            (avartar 'Mary', '2', pwd),
        ]
        field = [User.avartar, User.uname, User.gender, User.password]
        uid = User.insert_many(data_source, field).execute()
        print('uid=%d' % uid)
    

    控制台输出返回批量插入过程中第一条数据的自增pk;

    python peewee_test.py
    ('INSERT INTO `user` (`avartar`, `uname`, `gender`, `password`) VALUES (%s, %s, %s, %s), (%s, %s, %s, %s), (%s, %s, %s, %s)', ['https://avatars2.githubusercontent.com/u/25029451', 'Catherine', '2', 'e10adc3949ba59abbe56e057f20f883e', 'https://avatars2.githubusercontent.com/u/25029451', 'Jane', '2', 'e10adc3949ba59abbe56e057f20f883e', 'https://avatars2.githubusercontent.com/u/25029451', 'Mary', '2', 'e10adc3949ba59abbe56e057f20f883e'])
    uid=10003
    
    Process finished with exit code 0
    

    批量块添加方法

    如果要插入的数据量非常大,比如有千万条。一次性批量插入将会导致卡死,逐条插入也会导致耗时过长。此时可以折中寻求一个分批次批量插入的方案:使用peewee的chunked(it, n)方法将数据分割成小块数据(比如每次1000条,chunked(data_source, 1000))分批次批量插入:

    def create():
        """批量块添加数据"""
        data_source = [
            (avartar, 'Zoe', '2', pwd),
            (avartar, 'Lucy', '2', pwd),
            (avartar, 'Kara', '2', pwd),
            (avartar, 'Rex', '1', pwd),
        ]
        field = [User.avartar, User.uname, User.gender, User.password]
        for data_chunk in chunked(data_source, 2):
            User.insert_many(data_chunk, field).execute()
    

    控制台输出的信息表明了chunked的实质:

    python peewee_test.py
    ('INSERT INTO `user` (`avartar`, `uname`, `gender`, `password`) VALUES (%s, %s, %s, %s), (%s, %s, %s, %s)', ['https://avatars2.githubusercontent.com/u/25029451', 'Zoe', '2', 'e10adc3949ba59abbe56e057f20f883e', 'https://avatars2.githubusercontent.com/u/25029451', 'Lucy', '2', 'e10adc3949ba59abbe56e057f20f883e'])
    ('INSERT INTO `user` (`avartar`, `uname`, `gender`, `password`) VALUES (%s, %s, %s, %s), (%s, %s, %s, %s)', ['https://avatars2.githubusercontent.com/u/25029451', 'Kara', '2', 'e10adc3949ba59abbe56e057f20f883e', 'https://avatars2.githubusercontent.com/u/25029451', 'Rex', '1', 'e10adc3949ba59abbe56e057f20f883e'])
    
    Process finished with exit code 0
    

    Retrieve(1)

    读取单条数据

    直接调用get()方法,可以添加过滤(filter)条件。查询结果是一个User对象,直接打印得到pk,通过调用成员变量可以获得对应字段的值。特别的,当筛选条件为pk时,可以使用get_by_id()方法直接查询:

    def retrieve():
        """读取一条数据"""
        # result = User.get_by_id(10000)
        result = User.get(User.uname == 'Jack')
        print('直接打印:%s' % result)
        """查看结构"""
        print('\n'.join(['%s:%s' % item for item in result.__data__.items()]))
        print('用户名为:%s' % result.uname)
    

    控制台输出:

    python peewee_test.py
    ('SELECT `t1`.`uid`, `t1`.`addtime`, `t1`.`avartar`, `t1`.`balance`, `t1`.`gender`, `t1`.`integral`, `t1`.`logintime`, `t1`.`password`, `t1`.`uname` FROM `user` AS `t1` WHERE (`t1`.`uname` = %s) LIMIT %s OFFSET %s', ['Jack', 1, 0])
    直接打印:10001
    uid:10001
    addtime:2018-12-12 10:22:53
    avartar:https://avatars2.githubusercontent.com/u/25029451
    balance:0.00
    gender:1
    integral:0
    logintime:2018-12-12 10:22:53
    password:e10adc3949ba59abbe56e057f20f883e
    uname:Jack
    用户名为:Jack
    
    Process finished with exit code 0
    

    使用get()方法查询出来的数据包含了所有的字段。那么,当我们的需求是查询单条数据中的限定字段(fields)时,应该怎么查询呢?阅读get()方法的源码可以得知,其调用了select()方法返回的ModelSelect类中的get()方法:

    # peewee.py
    @classmethod
    def get(cls, *query, **filters):
        sq = cls.select()
        if query:
            sq = sq.where(*query)
        if filters:
            sq = sq.filter(**filters)
        return sq.get()
    

    因此,我们可以直接调用select()方法,然后调用get()方法,就可以实现需求。

    def retrieve():
        """查询一条数据中的限定字段(uname)"""
        result = User.select(User.uname).where(User.uid == 10001).get()
        """查看结构"""
        print('\n'.join(['%s:%s' % item for item in result.__data__.items()]))
    

    事实上,很多时候工作中遇到的单一查询都是只需要其中几个字段的数据,因此比起get()我用的更多的将会是select().get()。

    python peewee_test.py
    ('SELECT `t1`.`uname` FROM `user` AS `t1` WHERE (`t1`.`uid` = %s) LIMIT %s OFFSET %s', [10001, 1, 0])
    uname:Jack
    
    Process finished with exit code 0
    

    读取多条数据

    读取多条数据时,就要用到刚才提到的select()方法,这也是查询使用的主要方法。查阅select()方法源码可知,其返回一个ModelSelect类,然后我们再调用这个类的各种方法(where()、order_by()、limit()、offset())来实现查询的条件限定。如果你有特殊的需求,可以在链式操作的最后调用dicts()方法,将结果转化为一个字典。例如,我们要查询性别为男性、按注册日期降序(升序写字段,降序在字段前面再加个负号)排列的第二和第三位用户的编号和名称

    def retrieve():
        """读取多条数据"""
        query = User.select(User.uname, User.uid).order_by(-User.addtime).limit(2).offset(1).where(User.gender == '1')
        for row in query:
            print('%d:%s' % (row.uid, row.uname))
        """转换为字典形式"""
        print('转为字典形式:')
        query = User.select(User.uname, User.uid).order_by(-User.addtime).limit(2).offset(1).where(User.gender == '1').dicts()
        for row in query:
            print(row)
    
    python peewee_test.py
    ('SELECT `t1`.`uname`, `t1`.`uid` FROM `user` AS `t1` WHERE (`t1`.`gender` = %s) ORDER BY `t1`.`addtime` DESC LIMIT %s OFFSET %s', ['1', 2, 1])
    ('SELECT `t1`.`uname`, `t1`.`uid` FROM `user` AS `t1` WHERE (`t1`.`gender` = %s) ORDER BY `t1`.`addtime` DESC LIMIT %s OFFSET %s', ['1', 2, 1])
    10002:Micheal
    10001:Jack
    转为字典形式:
    {'uname': 'Micheal', 'uid': 10002}
    {'uname': 'Jack', 'uid': 10001}
    
    Process finished with exit code 0
    

    查询表达式

    根据文档,peewee的查询操作符由以下组成:

    比较符号 意义
    == x等于y
    < x小于y
    <= x小于等于y
    > x大于y
    >= x大于等于
    != x不等于y
    << x在数组y中
    >> x是y,这个y是None或者Null
    % x包含在y中
    ** 忽略大小写的x包含在y中
    ^ x异或y
    ~ 非x

    举例,模糊查询用户名包含J的用户:

    def retrieve():
        """模糊查询用户名包含J的用户"""
        # 包含J结尾的查询条件
        # query = User.select(User.uname, User.uid).where(User.uname % '%J').dicts()
        # 包含J的查询条件
        # query = User.select(User.uname, User.uid).where(User.uname % '%J%').dicts()
        # 包含J开头的查询条件
        query = User.select(User.uname, User.uid).where(User.uname % 'J%').dicts()
        for row in query:
            print(row)
    

    我们应该知道,模糊查询的时候使用右模糊查询可以有效地利用索引加快查询速度。

    python peewee_test.py
    ('SELECT `t1`.`uname`, `t1`.`uid` FROM `user` AS `t1` WHERE (`t1`.`uname` LIKE BINARY %s)', ['J%'])
    {'uname': 'Jack', 'uid': 10001}
    {'uname': 'Jane', 'uid': 10004}
    {'uname': 'John', 'uid': 10000}
    
    Process finished with exit code 0
    

    当然,因为操作符有限,无法表达全部功能,所以peewee同时也提供了方法用于代替操作符:

    方法 意义
    .in_(value) x在数组y中
    .not_in(value x不在数组y中
    .is_null(is_null) 判断是否为空,接受布尔值
    .contains(substr) 包含字符串,忽略大小写
    .startswith(prefix) 以字符串开头,忽略大小写
    .endswith(suffix) 以字符串结尾,忽略大小写
    .between(low, high) 在两个值的范围内
    .regexp(exp) 匹配正则表达式(大小写敏感)
    .iregexp(exp) 匹配正则表达式,忽略大小写
    .bin_and(value) 二进制的和
    .bin_or(value) 二进制的或
    .concat(other) 将两个字符串或对象临时合并
    .distinct() 指定字段过滤重复记录
    .collate(collation) 对列进行指定规则排序
    .cast(type) 将列的值按照指定类型转变

    还是上面的查询例子,等效用方法进行查询可改为:

    # 包含J结尾的查询条件
    # query = User.select(User.uname, User.uid).where(User.uname.endswith('j')).dicts()
    # 包含J的查询条件
    # query = User.select(User.uname, User.uid).where(User.uname.contains('j')).dicts()
    # 包含J开头的查询条件
    query = User.select(User.uname, User.uid).where(User.uname.startswith('j')).dicts()
    

    以及连接多个条件的逻辑运算符:

    符号 意义
    &
    |
    ~

    Update

    第一种更新方法

    和添加操作一样,更新也有多种方法。当条件中包含了pk时,调用save()方法就是更新:

    def update():
        """第一种更新方法"""
        user = User(gender='1')
        user.uid = 1006
        user.save()
    
    python peewee_test.py
    ('UPDATE `user` SET `gender` = %s WHERE (`uid` = %s)', ['1', 1006])
    
    Process finished with exit code 0
    

    第二种更新方法

    同insert(),改成update()就可以了,比第一种方法优越在于可以使用其他字段进行条件限定:

    def update():
        """第二种更新方法"""
        User.update(
            gender='2'
        ).where(User.uname == 'Zoe').execute()
    
    python peewee_test.py
    ('UPDATE `user` SET `gender` = %s WHERE (`uname` = %s)', ['2', 'Zoe'])
    
    Process finished with exit code 0
    

    Transaction

    掌握了最基本的CUR操作后,我们终于可以进行一些更为高级的操作。比如很重要很常用并且是InnoDB比MyISAM更为优越的功能:事务操作。peewee提供了两种事务开启的方法,这里只用第二种。
    首先,我们可以在models.py这个文件的BaseModel类中添加一个trans()方法,便于后面开启事务:

    # models.py
    class BaseModel(Model):
        def __init__(self, *args, **kwargs):
            super().__init__(*args, **kwargs)
            self.trans = database.atomic
    
        class Meta:
            database = database
    

    开启事务的方法

    def transaction():
        user = User()
        """开启事务"""
        with user.trans():
            pass
    
    

    在python中使用with开启的好处在于如果原子操作执行成功它可以自动提交、失败会自动回滚,不需要程序员手写提交和回滚代码,除此之外,视觉上更为优雅(pythonic)。当然如果你更习惯于完全手写也可以使用database.manual_commit()的方法来开启手动提交回滚操作。

    应用情景

    名为Jack的用户添加100.00余额,同时需要在余额操作记录表上插入一条记录。两个操作必须全部成功,否则全部失败。

    def transaction():
        user = User()
        result = user.select(User.uid, User.balance).where(User.uname == 'Jack').get()  # 查询用户的现有余额以及用户编号
        """开启事务"""
        with user.trans():
            try:
                user.update(
                    balance=result.balance+100
                ).where(User.uid == result.uid).execute()
                Balance.insert(
                    uid=result.uid,
                    change=100,
                    total=result.balance+100
                ).execute()
            except Exception:
                print('更新失败')
            else:
                print('更新成功')
    

    如果其中有一步操作失败,则整个事务自动回滚。

    python peewee_test.py
    ('SELECT `t1`.`uid`, `t1`.`balance` FROM `user` AS `t1` WHERE (`t1`.`uname` = %s) LIMIT %s OFFSET %s', ['Jack', 1, 0])
    ('UPDATE `user` SET `balance` = %s WHERE (`uid` = %s)', [Decimal('100.00'), 10001])
    ('INSERT INTO `balance` (`change`, `total`, `uid`) VALUES (%s, %s, %s)', [100, Decimal('100.00'), 10001])
    更新成功
    
    Process finished with exit code 0
    

    Retrieve(2)

    join

    当我们查看操作记录的时候,往往需要用户信息和操作记录组合起来,也就是mysql的join操作。例如,我们要时间降序查询用户编号为10001的用户的余额变更记录

    def retrieve2():
        """join查询"""
        query = Balance.select(
            User.uname, Balance.change,
            Balance.total, Balance.addtime
        ).join(
            User, JOIN.RIGHT_OUTER,
            on=(Balance.uid == User.uid)
        ).where(
            Balance.uid == 10001
        ).order_by(-Balance.addtime)
        for row in query:
            print('%s:%.2f:%.2f:%s' % (
                row.user.uname, row.change, row.total, row.addtime
            ))
    
    python peewee_test.py
    ('SELECT `t1`.`uname`, `t2`.`change`, `t2`.`total`, `t2`.`addtime` FROM `balance` AS `t2` RIGHT OUTER JOIN `user` AS `t1` ON (`t1`.`uid` = `t2`.`uid`) WHERE (`t2`.`uid` = %s) ORDER BY `t2`.`addtime` DESC', [10001])
    Jack:100.00:200.00:2018-12-12 17:24:32
    Jack:100.00:100.00:2018-12-12 16:31:15
    
    Process finished with exit code 0
    

    union[ all]

    关于union的操作姿势,官方文档也提供了多种方式,包括操作符、方法等等。

    操作符 意义
    | union
    + union all

    当我们需要把余额操作记录和积分操作记录并作操作记录统计时间降序查看第二和第三条数据(尽管这意义不大,且实际上我本来是想用订单统计来作为示例)的时候,union|union all就可以派上用场:

    def retrieve2():
        """union_all查询"""
        b_query = (Balance.select(
            Balance.b.alias('id'), Balance.change,
            Balance.total, Balance.addtime
        ))
        i_query = (Integral.select(
            Integral.i.alias('id'), Integral.change,
            Integral.total, Integral.addtime
        ))
        query = (b_query + i_query).order_by(SQL('addtime desc')).limit(2).offset(1)
        # query = b_query.union_all(i_query).order_by(SQL('addtime desc')).limit(2).offset(1)
        for row in query:
            print('%d:%.2f:%.2f:%s' % (row.id, row.change, row.total, row.addtime))
    

    没错,union_all的操作看起来仿佛将两个元组连接一样(实际上源码 __add__ = union_all)。如果对此感到不习惯,也可以用方法union_all()来代替。值得注意的是,在方法order_by()中,不能直接写入'addtime desc'这样的字符串,因为peewee不会将其解析为sql语句。你需要使用SQL类将其转化为sql语句才能使排序生效(参考自StackOverflow)。

    python peewee_test.py
    ('SELECT `t1`.`b_id` AS `id`, `t1`.`change`, `t1`.`total`, `t1`.`addtime` FROM `balance` AS `t1` UNION ALL SELECT `t2`.`i_id` AS `id`, `t2`.`change`, `t2`.`total`, `t2`.`addtime` FROM `integral` AS `t2` ORDER BY addtime desc LIMIT %s OFFSET %s', [2, 1])
    1:300.00:300.00:2018-12-13 10:16:27
    4:100.00:200.00:2018-12-12 17:24:32
    
    Process finished with exit code 0
    

    聚合查询

    聚合查询包括count、max、min、avg、sum。

    count

    def count():
        """统计用户个数"""
        count = User.select().count()
        print('用户数量:%d' % count)
        """fn.COUNT用法"""
        fn_count = User.select(fn.COUNT(User.uid)).scalar()
        print('fn.COUNT:%d' % fn_count)
    

    max

    def max():
        fn_max = User.select(fn.MAX(User.balance)).scalar()
    

    min

    def min():
        fn_min = User.select(fn.MIN(User.balance)).scalar()
    

    avg

    def avg():
        fn_avg = User.select(fn.AVG(User.balance)).scalar()
    

    sum

    def sum():
        fn_sum = Balance.select(fn.SUM(Balance.change)).where(Balance.uid == 10001).scalar()
    

    Delete

    删除调用delete()方法,使用execute()执行

    def delete():
        result = User.delete().where(User.uid == 10009).execute()
        print(result)
        result2 = User.delete().where(User.uid << (10006, 10007, 10008, 10009)).execute()
        print(result2)
    

    返回值为成功删除的数据条数。

    原生sql支持

    使用pwiz生成models.py文件中,储存着一个类MySQLDatabase,包含了数据库连接的信息。这个类有一个cursor()方法,可以用来执行原生sql语句(如果你的peewee版本低于3.0,这个方法名是get_cursor())。
    在models.py中的BaseModel添加self.cursor = database.cursor
    简单查询示例

    def sql():
        user = User()
        cursor = user.cursor()
        cursor.execute('SELECT `uid`, `uname`, `gender` FROM `user` WHERE `uid`=10001')
        for (uid, uname, gender) in cursor:
            print('%d:%s:%s' % (uid, uname, gender))
    

    批量插入使用executemany(),参考自CSDN
    在models.py中的BaseModel添加self.commit = database.commit

    def sql():
        """执行批量插入"""
        user = User()
        cursor = user.cursor()
        """md5密码"""
        m = hashlib.md5()
        m.update('123456'.encode())
        pwd = m.hexdigest()
        """头像"""
        avartar = 'https://avatars2.githubusercontent.com/u/25029451'
        data_source = [
            (avartar, 'Rem', pwd),
            (avartar, 'Cosmos', pwd)
        ]
        result = cursor.executemany('insert into `user`(`avartar`, `uname`, `password`) values (%s, %s, %s) ', data_source)
        print(result)  # 返回插入条数
        user.commit()  # 需要手动提交事务插入才能成功
        cursor.close()
    

    总结

    文中记录了我目前能想起来的工作中使用频率较高的一些操作。其他的操作由于没想起来便没作记录,也许日后会更新加入。除此之外,锁、隔离级别、分布式支持在peewee中的体现我暂时没有什么头绪,待google看看。关于锁,官方文档中提到基本上都是sqlite相关的,还有一个乐观锁的例子,但我粗略看了一下需要在表中添加version字段,所以没有采用。

    相关文章

      网友评论

          本文标题:peewee用法考察

          本文链接:https://www.haomeiwen.com/subject/rigphqtx.html