Elasticsearch Document APIs

Document APIs官方文档：https://www.elastic.co/guide/en/elasticsearch/reference/current/docs.html

Single document APIs

Index API

创建文档，可以自定义 id。接收一个op_type参数，其值为create，等同于_create。如果文档的 id 存在将会报错。

PUT users/_doc/1?op_type=create
{
    "user" : "Jack",
    "post_date" : "2019-05-15T14:12:12",
    "message" : "trying out Elasticsearch"
}

# 等同于下面这种形式
PUT users/_create/1
{
    "user" : "Jack",
    "post_date" : "2019-05-15T14:12:12",
    "message" : "trying out Elasticsearch"
}

创建 documenet 并自动生成 id。此时的 id 将会是 "_id" : "fz10xW4B_eVh03pFF41Y", 的形式。

POST users/_doc
{
  "user" : "Jack",
  "post_date" : "2019-05-15T14:12:12",
  "message" : "trying out Elasticsearch"
}

Get API

GET users/_doc/1

另外，我们可以只查看_source里面的内容，GET my_index/_source/1 。我们还可查看除_source之外的其他内容， GET my_index/_doc/1?_source=false。

Delete API

DELETE users/_doc/1

Update API

更新的时候，文档必须已经存在。同时，更新只对相应字段做增量修改，或者说是合并操作（Merge Operation）。

#在原文档上增加字段
POST users/_update/1/
{
    "doc":{
        "post_date" : "2019-05-15T14:12:12",
        "message" : "trying out Elasticsearch"
    }
}

还有一种操作不属于 Update API 但达到的是更新操作，有的时候，我们想对文档进行全部替换，而非增量操作，可考虑使用Index API来实现。

#Update 指定 ID  (先删除，在写入)
PUT users/_doc/1
{
    "user" : "Mike"
}

Multi-document APIs

Multi get(mget) API

批量获取API，用于查询一个或多个索引。从Elasticsearch7.x开始，索引下面的类型推荐只有一个，且名称必须为_doc。

批量读取一次可以根据条件获取多个结果批量操作，可以减少网络连接所产生的开销，提高性能

GET /_mget
{
    "docs" : [
        {
            "_index" : "user",
            "_id" : "1"
        },
        {
            "_index" : "comment",
            "_id" : "2"
        }
    ]
}

我们还可以查询同一个索引。

GET /test/_mget
{
  "docs" : [
    {
      "_type" : "_doc",
      "_id" : "1"
    },
    {
      "_type" : "_doc",
      "_id" : "2"
    }
  ]
}

我们还可以进一步简写。

GET /test/_doc/_mget
{
  "docs" : [
    {
      "_id" : "1"
    },
    {
      "_id" : "2"
    }
  ]
}

我们还可以再进一步简写。

GET /test/_doc/_mget
{
  "ids" : ["1", "2"]
}

Bulk API

一次请求 Rest API 的操作的开销是比较大的，Bulk API 的思想是就是在一次 API 调用中，对索引进行不同的操作。

支持四种类型操作：

• Index
• Create
• Update
• Delete

可以在 URL 中指定 Index，也可以再请求的 PayLoad 中进行操作中单条操作失败，并不会影响其他操作返回结果包含了每一条操作的执行结果

#执行第1次
POST _bulk
{ "index" : { "_index" : "test", "_id" : "1" } }
{ "field1" : "value1" }
{ "delete" : { "_index" : "test", "_id" : "2" } }
{ "create" : { "_index" : "test2", "_id" : "3" } }
{ "field1" : "value3" }
{ "update" : {"_id" : "1", "_index" : "test"} }
{ "doc" : {"field2" : "value2"} }

1、每个操作都有返回

2、单条操作失败，不影响其他的操作进行

常见错误返回

错误	原因
无法连接	网络故障或集群挂了
连接无法关闭	网络故障或节点出错
429	集群过于繁忙
4xx	请求体格式出错
500	集群内部错误