在 Flask-SQLAlchemy 中联表查询

Posted 2023-03-14

参考技术A SQLAlchemy 是一个功能强大的 ORM 。 Flask-SQLAlchemy 是一个 Flask 插件，它让我们在 Flask 框架中使用 SQLAlchemy 变得更容易。

本篇介绍我在使用 Flask-SQLAlchemy 2.1 时进行联表查询的一些经验

这里有两个表，account 表保存帐号 ID 和昵称，bind 表保存 account 之间的绑定关系。

对应的 Model 如下：

先来看一个简单的例子：查询 gameuid 1000 账号下绑定的所有帐号。

看一看生成的 SQL 语句：

这里的联表查询使用的是 WHERE 语句。如果希望使用 JOIN 语句，可以这样写：

可以看出，现在生成的 SQL 语句已经使用 JOIN 语句了。但上面的语意有点奇怪，既然已经在 query 中使用了 Bind 和 Account，后面再 join 一次 Account 总觉得有点多余。那么 SQLAlchemy 如何选择 JOIN 的时候谁先谁后呢？看看这个错误就知道了：

这个错误显然说明，query 中参数的顺序很重要，第一个参数所代表的 table 就是 JOIN 时放在前面的那个 table。因此，此处 JOIN 的目标应该是 Account， 而不应该是 Bind 自身。

上面的例子已经解决了大多数需求了。我们再来看看分页。在 Flask-SQLAlchemy 中封装了一个 paginate 方法，可以方便地将查询记录进行分页：

报错的原因是 db.session.query 默认返回的是 orm.Query 对象，这个对象并不包含 paginate 方法。要解决这个问题，需要修改 Flask-SQLAlchemy 的源码。

找到 SQLAlchemy 对象的 __init__ 定义，在其中加入 session_options['query_cls'] = BaseQuery 即可：

在 Flask-SQLAlchemy 提供的 Model 对象中，可以使用 Model.query 这样的语法来直接得到一个查询对象，这是由于 Flask-SQLAlchemy 中存在一个 _QueryProperty 类，每次调用 Model.__get__ 时，会自动生成一个基于当前 session 的 query 对象：

使用 Model.query 得到的这个 query 对象可以直接进行 JOIN 操作，得到的结果是 Model 对象。这样就方便多了：

转换成 SQL 是这样的：

可以看出，这样的查询结果和使用 db.session.query 并没有什么不同。由于返回的是 Model 对象，使用上可能还更加方便了。

如何使用 Model.query.join 语法得到部分字段呢？这里可以使用 SQLAlchemy 提供的 with_entities 方法：

注意，列表中的项 (2, '玩家10001') 并不是标准的 Python tuple。你如果查看它的类型，会发现一个奇怪的名称： <class 'sqlalchemy.util._collections.result'> 。它是一个 AbstractKeyedTuple 对象，拥有一个 keys() 方法，这样可以很容易将其转换成 dict ：

想了解 AbstractKeyedTuple ，可以看看这篇文档 New KeyedTuple implementation dramatically faster 。

除了筛选字段外，还可以用另一个方法获取多个 Model 的记录。那就是，返回两个 Model 的所有字段：

使用上面的语法直接返回 Account 和 Bind 对象，可以进行更加灵活的操作。

要联结超过 2 张以上的表，可以直接在 join 得到的结果之后链式调用 join 。也可以在 filter 的结果后面链式调用 join 。join 和 filter 返回的都是 query 对象，因此可以无限链式调用下去。

写完查询后，应该打印生成的 SQL 语句查看一下有没有性能问题。