Elasticsearch(035)：es中Document（文档）之修改文档

逃离我推掉我的手 2022-12-11 07:26 645阅读 0赞

# 一、概述 #

回顾前几个小节，我们学习了[文档的新增][Link 1]、[文档的删除][Link 2]、[文档的查询][Link 3]。当然，在实际的使用，存在诸多场景对文档进行修改操作的需求，在这一小节中，我们来学习下ES中文档常见的修改api。

# 二、全量更新（等于删除重建重新索引） #

## 2.1 说明 ##

这种是比较常见的，也就是覆盖更新。所谓的**覆盖更新**，就是是把原来的值都删掉，只保留新操作填充的字段值。（相当于删除了重新添加一个。其中可能除了id,其他的值可能都不相同）。

示例如下。

## 2.2 示例 ##

PUT example
    
    # 新建mapping
    PUT example/docs/_mapping
    { 
      "properties": { 
        "id":{ 
          "type": "long"
        },
        "name":{ 
          "type": "text"
        },
        "birthday": { 
          "type": "date"
        }
      }
    }
    
    # 新增记录
    PUT example/docs/1
    { 
      "id":1,
      "name":"张三",
      "birthday": "2019-10-10"
    }
    
    # 新增记录
    PUT example/docs/2
    { 
      "id":2,
      "name":"张四",
      "birthday": "2017-08-08"
    }
    
    # 查询id为1的记录
    GET example/docs/1
    
    #对id为1的生日进行更新，更新为2009-09-09
    POST example/docs/1
    { 
        "birthday": "2009-09-09"
    }
    
    GET example/docs/1

# 三、部分更新 #

## 3.1 Scripted updated(脚本更新) ##

### 3.1.1 说明 ###

ES的更新API允许基于提供的脚本来更新文档。使用脚本来更新文档的话，*需要开启ES的脚本支持功能*。具体方式可参考官方手册。

> **小贴士**
> 
> 注意 在ES中更新操作是完全重新索引文件。

### 3.1.2 示例 ###

*  索引及映射结构准备

PUT example
    
    PUT example/docs/_mapping
    { 
      "properties": { 
        "id": { "type": "long"},
        "name": { "type": "text"},
        "counter": { "type": "integer"},
        "tags": { "type": "text"}
      }
    }
    
    PUT example/docs/1
    { 
        "id": 1,
        "name": "test01",
        "counter": 2,
        "tags": ["red", "white"]
    }
    
    #查询所有
    GET example/docs/_search
    { 
      "query": { 
        "match_all": { }
      }
    }

*  **需求1:** 将id为1的counter加上100、tags中多添加一种颜色blue。

POST example/docs/1/_update
    { 
      "script": { 
          "lang": "painless",
          "source": "ctx._source.counter += params.num; ctx._source.tags.add(params.color)",
          "params": { 
            "num": 10,
            "color": "blue"
          }
      }
    }

执行完毕，发现更新结果如我们预期的一样。

> **小贴士**
> 
> ctx代表es中文档的上下文的概念。可以使用`_source`, `_index`, `_type`, `_id`, `_version`, `_routing`, `_parent`, `_ttl`等等所有相关的元数据类型的字段。

*  **需求2**：更新id为1的文档，在原有值的基础上添加一个`newName`的列。默认值给’xxx’

POST example/docs/1/_update
    { 
        "script": { 
            "lang": "painless",
            "source":"ctx._source.newName='xxx'"
        }
    }

*  **需求3**：删除id为1的newName字段（删除已有字段）

POST example/docs/1/_update
    { 
        "script": "ctx._source.remove('newName')"
    }

*  **需求4**：假如此次更新的tag是则其中有blue的话，则删除该document。否则就不删除（动态判断进行操作）

# 不包含的情况
    POST example/docs/1/_update
    { 
        "script": { 
            "lang": "painless",
            "source": "if (ctx._source.tags.contains(params.tag)) {ctx.op='delete'} else {ctx.op='none'}",
            "params": { 
                "tag": "yellow"
            }
        }
    }
    
    # 包含的情况
    POST example/docs/1/_update
    { 
        "script": { 
            "lang": "painless",
            "source": "if (ctx._source.tags.contains(params.tag)) {ctx.op='delete'} else {ctx.op='none'}",
            "params": { 
                "tag": "blue"
            }
        }
    }

## 3.2、Update with a partial document ##

## 3.2.1 说明 ##

更新API还支持传递部分文档，该文档将合并到现有文档中（简单的**递归合并，对象的内部合并**，替换核心“键/值”和数组等）。

## 3.2.2 示例 ##

POST example/docs/1/_update
    { 
      "doc": { 
        "newName": "xxxx"
      }
    }

执行完毕后，我们发现文档1中多了一个字段`newName`,并且值为`xxxx`。

> **注意**
> 
> 如果同时指定了`doc`和`script`，则`doc`将被忽略。最好是将部分文档的字段对放在脚本本身中。也是说不是很推荐上面那种写法。  
> 此外还有一点，如果此次的更新操作并不会实际的文档造成任何改变的话，那么这次更新操作的内容将会被忽略。因为es具有`detecting noop updates`机制。

## 3.3、upsert ##

### 3.3.1 说明 ###

顾名思义，更新/插入。意思就是**文档不存在时作为新增插入文档；如果文档存在则执行script脚本，执行更新操作**。

### 3.3.2 示例 ###

POST example/docs/2/_update
    { 
        "script": { 
            "lang": "painless",
            "source": "ctx._source.counter+=params.count",
            "params": { 
                "count": 5
            }
        },
        "upsert":{ 
            "counter": 2
        }
    }

### 3.3.3 重要参数 ###

*  `script_upsert`

如果希望脚本运行而不管文档是否存在，请执行脚本处理初始化文档而不是upsert元素， 只需要将scripted\_upsert设置为true。形如下。

POST example/docs/2/_update
    { 
        "scripted_upsert": true,
        "script": { 
            "id": "test_id",
            "params": { 
                "user": { 
                    "id": 1,
                    "name": "test_name",
                    "age": 22
                }
            }
        },
        "upsert":{ }
    }

*  `doc_as_upsert`

将`doc_as_upsert`设置为`true`,es是发送doc其中的数据作为upsert值。如下。

example/docs/2/_update
    { 
        "doc" : { 
            "name" : "new_name"
        },
        "doc_as_upsert" : true
    }

# 四、查询更新 #

## 4.1 用法 ##

`_update_by_query`的最简单用法是在不更改源的情况下对索引中的每个文档执行更新。这对于*选择新属性*或其他一些*在线映射更改*很有用。

POST example/docs/_update_by_query?conflicts=proceed
    
    #返回结果如下
    { 
      "took": 20,
      "timed_out": false,
      "total": 2,
      "updated": 2,
      "deleted": 0,
      "batches": 1,
      "version_conflicts": 0,
      "noops": 0,
      "retries": { 
        "bulk": 0,
        "search": 0
      },
      "throttled_millis": 0,
      "requests_per_second": -1,
      "throttled_until_millis": 0,
      "failures": []
    }

**注意**

所有更新和查询失败都会导致`_update_by_query`中止，并在响应失败返回。已执行的更新仍然保留。换句话说，该过程不会回滚，只会中止。当第一个失败导致中止时，失败的批量请求返回的所有失败都将在failures元素中返回。因此可能会有很多失败的实体。

如果想要避免上述的情况，加上`?conflicts=proceed`参数即可避免。

## 4.2 \_update\_by\_query和DSL ##

`_update_by_query`还可以使用`DSL`语法一起使用，实现对多个文档的数据更新。

示例

GET example/docs/_search
    { 
      "query": { 
        "term": { 
          "name": "test01"
        }
      }
    }
    
    #更新执行之前的查询结果
    { 
      "took": 0,
      "timed_out": false,
      "_shards": { 
        "total": 5,
        "successful": 5,
        "skipped": 0,
        "failed": 0
      },
      "hits": { 
        "total": 1,
        "max_score": 0.2876821,
        "hits": [
          { 
            "_index": "example",
            "_type": "docs",
            "_id": "1",
            "_score": 0.2876821,
            "_source": { 
              "id": 1,
              "name": "test01",
              "counter": 2,
              "tags": [
                "red",
                "white"
              ]
            }
          }
        ]
      }
    }

使用DSL方法执行更新语句之后

POST example/docs/_update_by_query
    { 
      "script": { 
        "lang": "painless",
        "source": "ctx._source.counter++"
      },
      "query": { 
        "term": { 
          "name": "test01"
        }
      }
    }
    
    #更新后进行查新结果如下
    { 
      "took": 1,
      "timed_out": false,
      "_shards": { 
        "total": 5,
        "successful": 5,
        "skipped": 0,
        "failed": 0
      },
      "hits": { 
        "total": 1,
        "max_score": 0.2876821,
        "hits": [
          { 
            "_index": "example",
            "_type": "docs",
            "_id": "1",
            "_score": 0.2876821,
            "_source": { 
              "name": "test01",
              "id": 1,
              "counter": 3,
              "tags": [
                "red",
                "white"
              ]
            }
          }
        ]
      }
    }

[Link 1]: https://gyoomi.blog.csdn.net/article/details/108364839
[Link 2]: https://gyoomi.blog.csdn.net/article/details/108403419
[Link 3]: https://gyoomi.blog.csdn.net/article/details/108712310