SQLAlchemy 2.x 中正确获取 ORM 实体对象的完整指南

星瑶同学_8606

星瑶同学_8606

2026-09-03

977人浏览

原创

SQLAlchemy 2.x 中正确获取 ORM 实体对象的完整指南

在 SQLAlchemy 2.x 异步模式下,session.scalar() 返回单个标量值(如 ID),而非完整 ORM 对象;应改用 session.scalars().one_or_none() 或 result.scalars().one_or_none() 才能正确解析为声明式模型实例。

在 sqlalchemy 2.x 异步模式下,`session.scalar()` 返回单个标量值(如 id),而非完整 orm 对象;应改用 `session.scalars().one_or_none()` 或 `result.scalars().one_or_none()` 才能正确解析为声明式模型实例。

SQLAlchemy 2.x 对异步会话(AsyncSession)的查询结果处理机制与旧版有显著差异,尤其体现在 ORM 对象解析行为上。许多开发者遇到的问题是:明明查询的是整个 Manga 模型,却只得到元组或单个字段(如 manga_id),这并非 Bug,而是 API 设计意图的体现——关键在于区分 scalar()、scalars() 和 execute() 的返回语义。

✅ 正确用法:获取 ORM 实例(非元组)

要返回完整的 Manga 对象(即 ORM 映射的 Python 实例),必须通过 .scalars() 方法提取 ORM 结果流,再调用 .one_or_none()(单行)或 .first()(首行)等终结方法:

from sqlalchemy import select
from typing import Optional

async def get_by_title(session: AsyncSession, title: str) -> Optional[Manga]:
    query = select(Manga).where(Manga.title == title).limit(1)
    result = await session.scalars(query)  # ← 返回 ScalarResult[Manga]
    return result.one_or_none()  # ← 返回 Manga 实例 或 None

或者,若需复用 execute()(例如后续还需访问原始行数据):

async def get_by_title_v2(session: AsyncSession, title: str) -> Optional[Manga]:
    query = select(Manga).where(Manga.title == title).limit(1)
    result = await session.execute(query)  # ← 返回 Result(含完整行)
    return result.scalars().one_or_none()  # ← 同样返回 Manga 实例

⚠️ 常见误区解析

方法 返回类型 行为说明
session.scalar(query) Any(通常是第一列值) 仅取结果集中第一行第一列的原始值(如 manga_id: int),不触发 ORM 映射
session.scalars(query) ScalarResult[T] 将每行自动映射为指定 ORM 类型 T(如 Manga),返回可迭代/终结的标量结果集
session.execute(query) Result 返回底层行对象(Row),需显式调用 .scalars() 或 .mappings() 才能转为 ORM 或字典

? 补充验证:print(type(result.one_or_none())) 应输出 <class></class>;若为 tuple 或 int,说明误用了 scalar()。

? 最佳实践建议

  • ✅ 优先使用 scalars() + one_or_none():语义清晰、类型安全,符合 SQLAlchemy 2.x 推荐范式;
  • ✅ 在 select() 中明确指定模型类(如 select(Manga)),而非 select(*),确保 ORM 映射上下文可用;
  • ❌ 避免 session.scalar(select(Manga).where(...)) —— 它等价于 session.scalar(select(Manga.manga_id).where(...)),仅返回 ID;
  • ? 若需多对象,用 scalars().all() 或 scalars().fetchall();若需严格单结果且不存在时报错,用 .one() 而非 .one_or_none()。

通过理解 scalars() 是 ORM 实体解析的“开关”,你就能彻底告别元组困扰,让 SQLAlchemy 真正按预期返回结构化、可操作的领域对象。

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

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

下载

相关标签:

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

相关专题

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

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

2023.07.20

1571

4

python能做什么
python能做什么

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

2023.07.25

3744

7

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

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

2023.07.31

1589

3

python教程
python教程

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

2023.08.03

21437

23

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

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

2023.08.04

2647

5

python eval
python eval

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

2023.08.04

2707

5

scratch和python区别
scratch和python区别

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

2023.08.11

1083

5

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

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

2023.08.10

576

4

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

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

2023.08.11

2083

5

热门下载

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

精品课程

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

共6课时 | 54.6万人学习

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

共89课时 | 133.2万人学习