首页
/ MikroORM中嵌入式属性的Upsert操作问题解析

MikroORM中嵌入式属性的Upsert操作问题解析

2025-05-28 15:48:31作者:薛曦旖Francesca

问题背景

在使用MikroORM进行数据库操作时,开发者遇到了一个关于嵌入式属性(Embedded Property)在upsert操作中的异常行为。具体表现为当尝试通过upsert方法更新已存在实体时,嵌入式属性无法被正确更新。

问题复现

首先我们来看一个典型的实体定义示例:

@Embeddable()
class Properties {
  @Property()
  tag: string;

  constructor(tag: string) {
    this.tag = tag;
  }
}

@Entity()
class User {
  @PrimaryKey()
  id!: number;

  @Property()
  name: string;

  @Property({ unique: true })
  email: string;

  @Embedded()
  properties: Properties;

  constructor(name: string, email: string, properties: Properties) {
    this.name = name;
    this.email = email;
    this.properties = properties;
  }
}

当执行以下upsert操作时:

await orm.em.upsert(User, {
  name: "Foo",
  email: "foo",
  properties: {
    tag: "foo2",
  },
});

如果数据库中已存在email为"foo"的用户记录,理论上应该更新该记录的所有字段,包括嵌入式属性properties.tag。然而实际生成的SQL语句中却缺少了对properties_tag字段的更新:

insert into `user` (`email`, `name`, `properties_tag`) 
values ('foo', 'Foo', 'foo2') 
on conflict (`email`) 
do update set `name` = excluded.`name` 
returning `id`, `properties_tag`

问题分析

这个问题源于MikroORM在处理嵌入式属性的upsert操作时存在两个关键缺陷:

  1. 默认行为缺陷:当不显式指定onConflictMergeFields时,嵌入式属性不会被自动包含在更新字段中。

  2. 显式指定时的语法问题:当尝试显式包含嵌入式属性时,直接使用"properties"会导致SQL语法错误,因为数据库层面实际存储的是展开后的字段properties_tag。

解决方案

经过深入分析,我们找到了几种可行的解决方案:

  1. 完整路径指定法(推荐):
await orm.em.upsert(
  User,
  {
    name: "Baz",
    email: "baz",
    properties: {
      tag: "baz2",
    },
  },
  {
    onConflictFields: ["email"],
    onConflictMergeFields: ["name", "properties.tag" as keyof User],
  }
);

这种方法通过完整指定嵌入式属性的路径(包含点号表示法)来精确控制需要更新的字段。

  1. 直接字段名指定法
await orm.em.upsert(
  User,
  {
    name: "Baz",
    email: "baz",
    properties: {
      tag: "baz2",
    },
  },
  {
    onConflictFields: ["email"],
    onConflictMergeFields: ["name", "properties_tag" as keyof User],
  }
);

这种方法直接使用数据库中的实际字段名,但可读性稍差。

技术原理

MikroORM在处理嵌入式属性时,会在数据库层面将其展开为多个列。例如,properties.tag会被映射为properties_tag列。在upsert操作中:

  1. 默认情况下,ORM只会包含顶级字段在冲突更新中
  2. 嵌入式属性需要显式指定其完整路径或实际列名
  3. 类型断言(as keyof User)在某些情况下是必要的,以通过TypeScript的类型检查

最佳实践建议

  1. 对于包含嵌入式属性的upsert操作,建议总是显式指定onConflictMergeFields
  2. 优先使用点号表示法指定嵌入式属性的完整路径
  3. 在团队开发中,应建立统一的编码规范来处理这类情况
  4. 考虑为常用实体创建封装方法,避免重复处理这类问题

总结

MikroORM中嵌入式属性的upsert操作需要特别注意字段的指定方式。理解ORM如何将嵌入式属性映射到数据库列是解决这类问题的关键。通过本文介绍的方法,开发者可以确保嵌入式属性在各种操作场景下都能被正确处理。

登录后查看全文
热门项目推荐

热门内容推荐

最新内容推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
143
1.92 K
kernelkernel
deepin linux kernel
C
22
6
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
274
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
929
553
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
422
392
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
75
65
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
344
1.3 K
easy-eseasy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
36
8