Marten文档部分更新与补丁操作详解-优快云博客

Marten文档部分更新与补丁操作详解

marten .NET Transactional Document DB and Event Store on PostgreSQL 项目地址: https://gitcode.com/gh_mirrors/ma/marten

概述

在现代应用开发中，JSON文档存储已成为常见需求。Marten作为.NET生态中优秀的文档数据库库，提供了强大的部分更新（Partial Update）功能，也称为补丁（Patching）操作。这种机制允许开发者直接修改文档中的特定字段，而无需加载整个文档到内存中，既提高了效率又减少了资源消耗。

部分更新的优势

传统文档更新流程通常需要：

从数据库加载完整文档
反序列化为对象
修改对象属性
序列化回JSON
保存到数据库

而Marten的部分更新功能直接在数据库层面操作JSON，避免了不必要的序列化/反序列化过程，特别适合以下场景：

文档体积较大但只需修改少量字段
需要批量更新符合特定条件的文档
高并发环境下减少内存压力

基础API使用

设置字段值

最基本的操作是设置文档中某个字段的值：

// 设置单个文档的字段值
session.Patch<Target>(target.Id).Set(x => x.Number, 10);

// 批量设置符合条件的文档
session.Patch<Target>(x => x.Color == Colors.Blue)
    .Set(x => x.Number, 2);

新增字段

当文档结构变更需要添加新字段时：

session.Patch<Target>(new WhereFragment("(data ->> 'UpdatedAt') is null"))
    .Set("UpdatedAt", DateTime.UtcNow);

复制字段值

可以将现有字段的值复制到一个或多个新位置：

// 复制到单个新字段
session.Patch<Target>(target.Id)
    .Duplicate(t => t.String, t => t.AnotherString);

// 复制到多个字段
session.Patch<Target>(target.Id)
    .Duplicate(t => t.String,
        t => t.StringField,
        t => t.Inner.String,
        t => t.Inner.AnotherString);

数值操作

递增操作

对数值字段进行递增是非常常见的需求：

// 默认递增1
session.Patch<Target>(target.Id).Increment(x => x.Number);

// 指定递增值
session.Patch<Target>(target.Id).Increment(x => x.Number, 3);

集合操作

添加元素

向集合中添加元素支持多种方式：

// 追加到集合末尾
session.Patch<Target>(target.Id)
    .Append(x => x.Children, newChild);

// 仅在元素不存在时追加
session.Patch<Target>(target.Id)
    .AppendIfNotExists(x => x.Children, newChild);

// 插入到集合开头
session.Patch<Target>(target.Id)
    .Insert(x => x.Children, newChild);

// 在指定位置插入
session.Patch<Target>(target.Id)
    .Insert(x => x.Children, newChild, position: 2);

移除元素

从集合中移除元素同样灵活：

// 移除第一个匹配的元素
session.Patch<Target>(target.Id)
    .Remove(x => x.Children, childToRemove);

// 移除所有匹配的元素
session.Patch<Target>(target.Id)
    .Remove(x => x.Children, childToRemove, RemoveAction.RemoveAll);

高级操作

字段重命名

当文档结构变化需要重命名字段时：

session.Patch<Target>(target.Id)
    .Rename("OldFieldName", x => x.NewFieldName);

删除字段

移除不再需要的字段：

// 删除顶级字段
session.Patch<Target>(target.Id).Delete("ObsoleteField");

// 删除嵌套字段
session.Patch<Target>(target.Id)
    .Delete(x => x.Inner.ObsoleteField);