如何使用C# NEST结合脚本将Elasticsearch字段设为null？

问题场景 #

Elasticsearch中存在如下文档：

{
  "name": "Bob",
  "age": "22",
  "phrase": "ohohoho",
  "date": "2022-10-20T00:00:00Z"
}

对应C#类型中的字段：

string phrase;
DateTime? date;

期望将文档更新为：

{
  "name": "not Bob",
  "age": "22",
  "phrase": null,
  "date": null
}

使用以下C#代码实现更新：

var updateRequest = new UpdateRequest<T, T>(entity)
{
    ScriptedUpsert = true,
    Script = new InlineScript(
        $"if (someCondition) {{ctx._source.putAll(params.entity);}} else {{ctx.op = \"noop\";}}")
    {
        Lang = "painless",
        Params = new Dictionary<string, object>() { { "entity", entity } },
    },
    Upsert = Activator.CreateInstance<T>()
}; 

但最终无法更新phrase和date字段，生成的请求中所有null字段被跳过：

POST /myIndex/_update/b90278fd-1a66-40bf-b775-d076122c6c02
{
    "script": {
        "source": "if (someCondition) {ctx._source.putAll(params.entity);} else {ctx.op = \"noop\";}",
        "lang": "painless",
        "params": { 
          "entity": {
               "name": "",
               "age": 22
            }
        }
    },
    "upsert": {
        "age": 0
    }
}

解决方案 #

1. 配置序列化以包含null值 #

NEST客户端默认会忽略null字段，需要修改序列化设置，让客户端在序列化时保留null值：

var settings = new ConnectionSettings(new Uri("http://your-es-host:9200"))
    .DefaultIndex("myIndex")
    .SerializerSettings(s => s
        .NullValueHandling(NullValueHandling.Include)); // 关键配置：包含null值

var client = new ElasticClient(settings);

2. 修改Painless脚本逻辑 #

原脚本使用putAll方法时，若params.entity中字段为null（序列化后未包含该字段），则无法覆盖原文档字段。需改为遍历所有字段并显式赋值：

var updateRequest = new UpdateRequest<T, T>(entity)
{
    ScriptedUpsert = true,
    Script = new InlineScript(@"
        if (someCondition) {
            for (entry in params.entity.entrySet()) {
                ctx._source[entry.getKey()] = entry.getValue();
            }
        } else {
            ctx.op = ""noop"";
        }")
    {
        Lang = "painless",
        Params = new Dictionary<string, object> { { "entity", entity } },
    },
    Upsert = Activator.CreateInstance<T>()
};

通过遍历params.entity的所有键值对，无论值是否为null，都会显式写入ctx._source，从而实现将指定字段更新为null的需求。

3. 确保Upsert部分的null字段被保留 #

若Upsert操作也需要包含null字段，同样依赖第一步的序列化配置，确保Upsert对象的null字段被正确序列化并发送到Elasticsearch。

内容的提问来源于stack exchange，提问作者Roman Matkovskyi