如何在 Tortoise ORM 中为关联模型指定仅查询特定字段

雨磊同学_2409

雨磊同学_2409

2026-10-18

895人浏览

原创

如何在 Tortoise ORM 中为关联模型指定仅查询特定字段

Tortoise ORM 的 only() 方法默认不支持直接通过 "related__field" 语法筛选外键关联模型的字段;正确方式是结合 Prefetch 对象显式定义关联模型的查询集,并在其内部调用 only()。

tortoise orm 的 `only()` 方法默认不支持直接通过 `"related__field"` 语法筛选外键关联模型的字段;正确方式是结合 `prefetch` 对象显式定义关联模型的查询集,并在其内部调用 `only()`。

在使用 Tortoise ORM 进行关系查询时,开发者常希望优化数据加载,避免冗余字段传输。例如,查询 Token 模型时仅需获取其关联 Provider 的 id 和 description 字段,而非整个 Provider 实例。但若直接在主查询中使用 .only("id", "provider__description", "expires") 并配合 .select_related("provider"),会触发 KeyError: 'provider__description' —— 因为 only() 不支持跨表字段路径语法(如 provider__description),该语法仅适用于 Django ORM,Tortoise 并未实现此行为。

✅ 正确解法是使用 tortoise.query_utils.Prefetch 显式控制关联模型的查询范围:

from tortoise.query_utils import Prefetch
from models import Provider, Token

async def get_tokens(user_id: Optional[int] = None) -> List[Token]:
    query = Token.all().prefetch_related(
        Prefetch(
            "provider",
            queryset=Provider.all().only("id", "description")
        )
    )
    if user_id:
        query = query.filter(user_id=user_id)
    return await query

⚠️ 注意事项:

  • Prefetch 必须与 prefetch_related() 配合使用,不能与 select_related() 混用(后者执行 JOIN,不支持字段级粒度控制);
  • Prefetch.queryset 中的 only() 作用于关联模型本身,确保数据库仅返回指定字段;
  • 若未导入 Prefetch,需显式添加:from tortoise.query_utils import Prefetch;
  • only() 在 Prefetch 内部生效,主查询的 only() 仍仅作用于 Token 本体字段(如 "id", "expires")。

? 补充技巧:若还需关联 User 模型且只取部分字段,可链式添加多个 Prefetch:

.prefetch_related(
    Prefetch("provider", queryset=Provider.all().only("id", "description")),
    Prefetch("user", queryset=User.all().only("id", "username")),
)

综上,Tortoise ORM 的字段级懒加载依赖 Prefetch 机制,这是实现高效、精准关联查询的关键模式。

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1751

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

4524

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1729

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

26677

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3227

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3247

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1183

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

596

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2523

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.7万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.7万人学习