Tortoise ORM 中 exclude 过滤器的正确使用方式

在 Tortoise ORM 项目中，开发者经常会遇到需要查询不满足某些条件的记录的情况。本文将通过一个典型场景，深入分析 exclude 过滤器的使用方法和注意事项。

问题背景

在数据库查询中，我们经常需要找出"不包含某些关联记录"的数据。例如，在一个提供者(Provider)和令牌(Token)的系统中，可能需要查询某个用户尚未拥有令牌的所有提供者。

模型定义

首先让我们看看相关的模型定义：

class Provider(Model):
    name = fields.CharField(max_length=256, null=True)
    url = fields.CharField(max_length=256, null=True)
    short_description = fields.CharField(max_length=256, null=True)
    description = fields.TextField(default="")

class Token(Model):
    user = fields.ForeignKeyField("models.User", "tokens")
    token = fields.CharField(max_length=256, null=True)
    provider = fields.ForeignKeyField("models.Provider", "tokens")

常见误区

很多开发者会尝试使用 exclude 过滤器来实现这个需求：

async def get_providers_without_tokens(user_id: int):
    providers_without_tokens = await Provider.exclude(tokens__user_id=user_id).all()
    return providers_without_tokens

这种方法看似合理，但实际上生成的 SQL 查询可能不符合预期：

SELECT "provider"."name","provider"."id" FROM "provider" 
LEFT OUTER JOIN "token" ON "provider"."id"="token"."provider_id" 
WHERE NOT "token"."user_id"=?

这种查询方式的问题在于它使用了 LEFT OUTER JOIN 和 NOT 条件，而不是更直观的 NOT IN 子查询。

正确解决方案

要实现"查询用户没有令牌的提供者"这一需求，更可靠的方法是使用子查询：

from tortoise.expressions import Subquery

await Provider.filter(
    id__not_in=Subquery(
        Token.filter(user_id=1).values("provider_id")
    )
)

这种方法会生成更符合直觉的 SQL：

SELECT * FROM provider
WHERE provider.id NOT IN (
    SELECT provider_id FROM token WHERE user_id = 1
)

性能考量

在实际应用中，NOT IN 子查询和 LEFT JOIN + NOT 条件各有优缺点：

1. NOT IN 子查询：

   • 更直观，易于理解
   • 当子查询结果集较小时性能较好
   • 可能遇到 NULL 值处理问题

2. LEFT JOIN + NOT 条件：

   • 在某些数据库中对大表性能更好
   • 查询逻辑稍复杂
   • 需要处理 JOIN 带来的重复记录问题

最佳实践建议

1. 对于简单查询，两种方法都可以考虑
2. 对于复杂查询，建议先分析执行计划
3. 在不确定性能影响时，可以先在小数据集上测试
4. 考虑使用数据库特定的优化提示（如索引提示）

总结

Tortoise ORM 提供了灵活的查询方式，但开发者需要理解不同查询方法背后的 SQL 生成逻辑。在需要排除关联记录的场景下，使用子查询通常是更可靠的选择。理解这些底层机制有助于编写出更高效、更可靠的数据库查询代码。