Elasticsearch CRUD

发表于 更新于 分类于 ， ， 本文字数： 7.2k 阅读时长 ≈ 7 分钟

Elasticsearch CRUD

::: info 概述

CRUD 由英文单词 Create, Read, Update, Delete 的首字母组成，即增删改查。

本文通过介绍基本的 Elasticsearch CRUD 方法，向读者呈现如何访问 Elasticsearch 数据。
:::

CRUD 简介

Elasticsearch 的基本 CRUD 方式如下：

  • 新建文档 - ES 提供了 Index API 来新建文档。
    • PUT /<index>/_create/<_id> - 指定 id，如果 id 已存在，会报错
    • POST /<index>/_doc - 自动生成 _id
  • 删除文档 - ES 提供了 Delete API 来删除文档。
    • DELETE /<index>
  • 更新文档 - ES 提供了 Update API 来更新文档。
    • POST /<index>/_update/<_id>
  • 查询文档 - ES 提供了 Get API 来指定 ID 查询文档。
    • GET <index>/_doc/<_id>
  • 批量写 - ES 提供了 Bulk API(_bulk) 来执行批量写操作。Bulk API 支持 Index、Create、Update、Delete 四种操作。
  • 批量查 - ES 提供了 Multi Get API(_mget) 来执行批量指定 ID 查询操作。

索引管理

:::details 创建索引

创建索引 users：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
PUT users
{
  "mappings": {
    "properties": {
      "name": {
        "type": "keyword"
      },
      "age": {
        "type": "integer"
      },
      "message": {
        "type": "text"
      }
    }
  },
  "settings": {
    "number_of_shards": 1,
    "number_of_replicas": 1
  }
}

响应结果：

1
2
3
4
5
{
  "acknowledged": true,
  "shards_acknowledged": true,
  "index": "users"
}

:::

:::details 删除索引

删除索引 users：

1
DELETE users

响应结果：

1
2
3
{
  "acknowledged": true
}

:::

新建文档

ES 提供了 Index API 来新建文档。ES 提供了两种创建文档的方式：

  • PUT /<index>/_create/<_id> - 指定 id，如果 _id 已存在，会报错
  • POST /<index>/_doc - 自动生成 _id

:::details 不指定 ID 新建文档

ES 会自动为新建的文档分片一个 UID。

1
2
3
4
5
6
POST /users/_doc
{
    "user" : "dunwu",
    "age" : 20,
    "message" : "learning Elasticsearch"
}

响应结果：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
  "_index": "users",
  "_type": "_doc",
  "_id": "_JVCi5MBf44xQviy3tpW",
  "_version": 1,
  "result": "created",
  "_shards": {
    "total": 2,
    "successful": 1,
    "failed": 0
  },
  "_seq_no": 1,
  "_primary_term": 1
}

:::

:::details 指定 ID 新建文档

1
2
3
4
5
6
PUT users/_create/2
{
    "user" : "jason",
    "age" : 20,
    "message" : "learning Redis"
}

响应结果：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
  "_index": "users",
  "_type": "_doc",
  "_id": "2",
  "_version": 1,
  "result": "created",
  "_shards": {
    "total": 2,
    "successful": 1,
    "failed": 0
  },
  "_seq_no": 1,
  "_primary_term": 1
}

指定 ID 如果已经存在，返回报错。可以再执行一遍上面的指令，会得到类似下面的错误响应：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
  "error": {
    "root_cause": [
      {
        "type": "version_conflict_engine_exception",
        "reason": "[2]: version conflict, document already exists (current version [1])",
        "index_uuid": "bkNSOG6RTEet3Q65ynCuBA",
        "shard": "0",
        "index": "users"
      }
    ],
    "type": "version_conflict_engine_exception",
    "reason": "[2]: version conflict, document already exists (current version [1])",
    "index_uuid": "bkNSOG6RTEet3Q65ynCuBA",
    "shard": "0",
    "index": "users"
  },
  "status": 409
}

:::

删除文档

ES 提供了 Delete API 来删除文档。

:::details 指定 ID 删除文档

1
DELETE users/_doc/2

响应结果：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
  "_index": "users",
  "_type": "_doc",
  "_id": "2",
  "_version": 2,
  "result": "deleted",
  "_shards": {
    "total": 2,
    "successful": 1,
    "failed": 0
  },
  "_seq_no": 4,
  "_primary_term": 1
}

:::

更新文档

ES 提供了 Update API 来更新文档。

:::details 指定 ID 查询

1
2
3
4
5
6
POST users/_update/_JVCi5MBf44xQviy3tpW
{
  "doc": {
    "message": "learning HBase"
  }
}

响应结果：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
  "_index": "users",
  "_type": "_doc",
  "_id": "_JVCi5MBf44xQviy3tpW",
  "_version": 2,
  "result": "updated",
  "_shards": {
    "total": 2,
    "successful": 1,
    "failed": 0
  },
  "_seq_no": 2,
  "_primary_term": 1
}

:::

查询文档

ES 提供了 Get API 来指定 ID 查询文档。

:::details 指定 ID 查询

1
GET users/_doc/_JVCi5MBf44xQviy3tpW

响应结果：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
  "_index": "users",
  "_type": "_doc",
  "_id": "_JVCi5MBf44xQviy3tpW",
  "_version": 2,
  "_seq_no": 2,
  "_primary_term": 1,
  "found": true,
  "_source": {
    "user": "dunwu",
    "age": 20,
    "message": "learning HBase"
  }
}

:::

批量写

ES 提供了 Bulk API 来执行批量写操作。批量操作将多条操作合并为一次请求，大大提高了执行效率。Bulk API 支持 Index、Create、Update、Delete 四种操作。

:::details 批量操作

执行第 1 次：

1
2
3
4
5
6
7
8
POST _bulk
{ "index" : { "_index" : "test", "_id" : "1" } }
{ "field1" : "value1" }
{ "delete" : { "_index" : "test", "_id" : "2" } }
{ "create" : { "_index" : "test", "_id" : "3" } }
{ "field1" : "value3" }
{ "update" : {"_id" : "1", "_index" : "test"} }
{ "doc" : {"field2" : "value2"} }

响应结果：

1
2
3
4
5
6
7
{
  "took": 5436,
  "errors": false,
  "items": [
    // 略
  ]
}

执行第 2 次：

1
2
3
4
5
6
7
8
POST _bulk
{ "index" : { "_index" : "test", "_id" : "1" } }
{ "field1" : "value1" }
{ "delete" : { "_index" : "test", "_id" : "2" } }
{ "create" : { "_index" : "test", "_id" : "3" } }
{ "field1" : "value3" }
{ "update" : {"_id" : "1", "_index" : "test"} }
{ "doc" : {"field2" : "value2"} }

响应结果：

1
2
3
4
5
6
7
{
  "took": 1870,
  "errors": true,
  "items": [
    // 略
  ]
}

:::

批量查

ES 提供了 Multi Get API 来执行批量指定 ID 查询操作。

:::details 批量查询

1
2
3
4
5
6
7
8
9
10
11
12
13
GET /_mget
{
  "docs": [
    {
      "_index": "users",
      "_id": "_JVCi5MBf44xQviy3tpW"
    },
    {
      "_index": "users",
      "_id": "2"
    }
  ]
}

响应结果：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
{
  "docs": [
    {
      "_index": "users",
      "_type": "_doc",
      "_id": "_JVCi5MBf44xQviy3tpW",
      "_version": 2,
      "_seq_no": 2,
      "_primary_term": 1,
      "found": true,
      "_source": {
        "user": "dunwu",
        "age": 20,
        "message": "learning HBase"
      }
    },
    {
      "_index": "users",
      "_type": "_doc",
      "_id": "2",
      "_version": 1,
      "_seq_no": 3,
      "_primary_term": 1,
      "found": true,
      "_source": {
        "user": "jason",
        "age": 20,
        "message": "learning Redis"
      }
    }
  ]
}

:::

参考资料