Elasticsearch-RestFul（HTTP）基本操作

最新推荐文章于 2024-02-24 17:44:16 发布

魔笛Love

最新推荐文章于 2024-02-24 17:44:16 发布

阅读量1.1k

点赞数

文章标签： java 开发语言后端

本文链接：https://blog.csdn.net/clearlxj/article/details/121669847

版权

Elasticsearch 基本操作

RESTful

REST 指的是一组架构约束条件和原则。满足这些约束条件和原则的应用程序或设计就是 RESTful。Web 应用程序最重要的 REST 原则是,客户端和服务器之间的交互在请求之间是无状态的。从客户端到服务器的每个请求都必须包含理解请求所必需的信息。如果服务器在请求之间的任何时间点重启,客户端不会得到通知。此外,无状态请求可以由任何可用服务器回答,这十分适合云计算之类的环境。客户端可以缓存数据以改进性能。

在服务器端,应用程序状态和功能可以分为各种资源。资源是一个有趣的概念实体,它向客户端公开。资源的例子有:应用程序对象、数据库记录、算法等等。每个资源都使用 URI(Universal Resource Identifier) 得到一个唯一的地址。所有资源都共享统一的接口,以便在客户端和服务器之间传输状态。使用的是标准的 HTTP 方法,比如 GET、PUT、POST 和DELETE。

在 REST 样式的 Web 服务中,每个资源都有一个地址。资源本身都是方法调用的目标,方法列表对所有资源都是一样的。这些方法都是标准方法,包括 HTTP GET、POST、PUT、DELETE,还可能包括 HEAD 和 OPTIONS。简单的理解就是,如果想要访问互联网上的资源,就必须向资源所在的服务器发出请求,请求体中必须包含资源的网络路径,以及对资源进行的操作(增删改查)。

客户端安装

如果直接通过浏览器向 Elasticsearch 服务器发请求,那么需要在发送的请求中包含HTTP 标准的方法,而 HTTP 的大部分特性且仅支持 GET 和 POST 方法。所以为了能方便地进行客户端的访问,可以使用 Postman 软件

Postman 是一款强大的网页调试工具,提供功能强大的 Web API 和 HTTP 请求调试。软件功能强大,界面简洁明晰、操作方便快捷,设计得很人性化。Postman 中文版能够发送任何类型的 HTTP 请求 (GET, HEAD, POST, PUT…),不仅能够表单提交,且可以附带任意类型请求体。

Postman 官网:https://www.getpostman.com

Postman 下载:https://www.getpostman.com/apps

数据格式

Elasticsearch 是面向文档型数据库,一条数据在这里就是一个文档。为了方便大家理解,我们将 Elasticsearch 里存储文档数据和关系型数据库 MySQL 存储数据的概念进行一个类比

在这里插入图片描述

ES 里的 Index 可以看做一个库,而 Types 相当于表,Documents 则相当于表的行。

这里 Types 的概念已经被逐渐弱化,Elasticsearch 6.X 中,一个 index 下已经只能包含一个type, Elasticsearch 7.X 中, Type 的概念已经被删除了。

用 JSON 作为文档序列化的格式,比如一条用户信息:

{
    "name" : "John",
    "sex" : "Male",
    "age" : 25,
    "birthDate": "1990/05/01",
    "about" : "I love to go rock climbing",
    "interests": [ "sports", "music" ]
}

ES的数据发送和数据返回都是以JSON格式进行的，ES的存储也是JSON格式的。

HTTP 操作

这里的操作均是基于VsCode的REST Client的。

索引操作

创建索引

对比关系型数据库,创建索引就等同于创建数据库

向 ES 服务器发 PUT 请求 :http://10.10.10.113:9200/sanguo

其中sanguo表示索引的名称

返回结果为

{
  "acknowledged"【响应结果】: true,
  "shards_acknowledged"【分片结果】: true,
  "index"【索引名称】: "sanguo"
}

注意：创建索引库的分片数默认 1 片,在 7.0.0 之前的 Elasticsearch 版本中,默认 5 片

如果重复添加索引,会返回错误信息

{
  "error": {
    "root_cause": [
      {
        "type": "resource_already_exists_exception",
        "reason": "index [sanguo/Fs47tWZzSFqCD81JwNqiNw] already exists",
        "index_uuid": "Fs47tWZzSFqCD81JwNqiNw",
        "index": "sanguo"
      }
    ],
    "type": "resource_already_exists_exception",
    "reason": "index [sanguo/Fs47tWZzSFqCD81JwNqiNw] already exists",
    "index_uuid": "Fs47tWZzSFqCD81JwNqiNw",
    "index": "sanguo"
  },
  "status": 400
}

查看所有索引

向 ES 服务器发 GET 请求 :http://10.10.10.113:9200/_cat/indices?v

这里请求路径中的_cat 表示查看的意思,indices 表示索引,所以整体含义就是查看当前 ES服务器中的所有索引,就好像 MySQL 中的 show tables 的感觉,服务器响应结果如下

在这里插入图片描述

查看单个索引

向 ES 服务器发 GET 请求 :http://10.10.10.113:9200/sanguo

查看索引向 ES 服务器发送的请求路径和创建索引是一致的。但是 HTTP 方法不一致。这里可以体会一下 RESTful 的意义

服务器响应结果如下：

{
  "sanguo"【索引名】: {
    "aliases"【别名】: {},
    "mappings"【映射】: {},
    "settings"【设置】: {
      "index"【设置-索引】: {
        "creation_date"【设置-索引-创建时间】: "1638327524618",
        "number_of_shards"【设置-索引-主分片数量】: "1",
        "number_of_replicas"【设置-索引-副分片数量】: "1",
        "uuid"【设置-索引-唯一标识】: "Fs47tWZzSFqCD81JwNqiNw",
        "version"【设置-索引-版本】: {
          "created": "7080099"
        },
        "provided_name"【设置-索引-名称】: "sanguo"
      }
    }
  }
}

删除索引

向 ES 服务器发 DELETE 请求 :http://10.10.10.113:9200/sanguo

{
  "acknowledged": true
}

重新访问索引时,服务器返回响应:索引不存在

{
  "error": {
    "root_cause": [
      {
        "type": "index_not_found_exception",
        "reason": "no such index [sanguo]",
        "resource.type": "index_or_alias",
        "resource.id": "sanguo",
        "index_uuid": "_na_",
        "index": "sanguo"
      }
    ],
    "type": "index_not_found_exception",
    "reason": "no such index [sanguo]",
    "resource.type": "index_or_alias",
    "resource.id": "sanguo",
    "index_uuid": "_na_",
    "index": "sanguo"
  },
  "status": 404
}

文档操作

创建文档

索引已经创建好了,接下来我们来创建文档,并添加数据。这里的文档可以类比为关系型数据库中的表数据,添加的数据格式为 JSON 格式

向 ES 服务器发 POST 请求 :http://10.10.10.113:9200/sanguo/_doc

添加数据是必须有请求体，请求体如下：

{
  "name": "曹操",
  "age": 52,
  "country": "魏"
}

此处发送请求的方式必须为 POST,不能是 PUT,否则会发生错误

{
    "_index"【索引】: "sanguo",
    "_type"【类型-文档】: "_doc",
    "_id"【唯一标识】: "iF3-c30BdaWJQ8EZDKOg", #可以类比为 MySQL 中的主键,随机生成
    "_version"【版本】: 1,
    "result"【结果】: "created", #这里的 create 表示创建成功
    "_shards"【分片】: {
        "total"【分片-总数】: 2,
        "successful"【分片-成功】: 1,
        "failed"【分片-失败】: 0
    },
    "_seq_no": 0,
    "_primary_term": 1
}

上面的数据创建后,由于没有指定数据唯一性标识(ID),默认情况下,ES 服务器会随机生成一个。

如果想要自定义唯一性标识,需要在创建时指定http://10.10.10.113:9200/sanguo/_doc/1

{
  "_index": "sanguo",
  "_type": "_doc",
  "_id": "1",
  "_version": 1,
  "result": "created",
  "_shards": {
    "total": 2,
    "successful": 1,
    "failed": 0
  },
  "_seq_no": 1,
  "_primary_term": 1
}

多次发送统一id的结果

{
  "_index": "sanguo",
  "_type": "_doc",
  "_id": "1",
  "_version": 5,
  "result": "updated",
  "_shards": {
    "total": 2,
    "successful": 1,
    "failed": 0
  },
  "_seq_no": 5,
  "_primary_term": 1
}

此处需要注意:如果增加数据时明确数据主键,那么请求方式也可以为 PUT

查看文档

查看文档时,需要指明文档的唯一性标识,类似于 MySQL 中数据的主键查询

向 ES 服务器发 GET 请求 :http://10.10.10.113:9200/sanguo/_doc/1

{
    "_index"【索引】: "sanguo",
    "_type"【文档类型】: "_doc",
    "_id": "1",
    "_version": 5,
    "_seq_no": 5,
    "_primary_term": 1,
    "found"【查询结果】: true, # true 表示查找到,false 表示未查找到
    "_source"【文档源信息】: {
        "name": "曹丕",
        "age": 34,
        "country": "魏"
    }
}

查看索引全部文档

获取索引下所有文档，向 ES 服务器发 GET 请求 :http://10.10.10.113:9200/sanguo/_search

{
  "took"【耗费时间】: 129,
  "timed_out"【是否超时】: false,
  "_shards": {
    "total": 1,
    "successful": 1,
    "skipped": 0,
    "failed": 0
  },
  "hits": {
    "total": {
      "value": 2,
      "relation": "eq"
    },
    "max_score": 1.0,
    "hits": [
      {
        "_index": "sanguo",
        "_type": "_doc",
        "_id": "iF3-c30BdaWJQ8EZDKOg",
        "_score": 1.0,
        "_source": {
          "name": "曹操",
          "age": 52,
          "country": "魏"
        }
      },
      {
        "_index": "sanguo",
        "_type": "_doc",
        "_id": "1",
        "_score": 1.0,
        "_source": {
          "name": "曹丕",
          "age": 34,
          "country": "魏"
        }
      }
    ]
  }
}

修改文档（全量修改）

和新增文档一样,输入相同的 URL 地址请求,如果请求体变化,会将原有的数据内容覆盖

向 ES 服务器发 POST 请求 :http://10.10.10.113:9200/sanguo/_doc/1

请求体

{
  "name": "曹丕",
  "age": 34,
  "country": "魏",
  "identity": "魏文帝"
}

返回结果

{
  "_index": "sanguo",
  "_type": "_doc",
  "_id": "1",
  "_version"【数据版本】: 6,    # 对数据的操作都会更新版本
  "result"【结果】: "updated", # updated 表示数据被更新
  "_shards": {
    "total": 2,
    "successful": 1,
    "failed": 0
  },
  "_seq_no": 6,
  "_primary_term": 1
}

修改字段（局部修改）

修改数据时,也可以只修改某一给条数据的局部信息

向 ES 服务器发 POST 请求 :http://10.10.10.113:9200/sanguo/_update/1

请求体内容为:

{
  "doc": {
    "age": 35
  }
}

可通过查询检查修改是否成功

删除文档

删除一个文档不会立即从磁盘上移除,它只是被标记成已删除(逻辑删除)。

向 ES 服务器发 DELETE 请求 :http://10.10.10.113:9200/sanguo/_doc/1

返回体

{
  "_index": "sanguo",
  "_type": "_doc",
  "_id": "1",
  "_version": 8,
  "result": "deleted",
  "_shards": {
    "total": 2,
    "successful": 1,
    "failed": 0
  },
  "_seq_no": 8,
  "_primary_term": 1
}

删除后再查询当前文档信息

{
  "_index": "sanguo",
  "_type": "_doc",
  "_id": "1",
  "found": false
}

如果删除一个并不存在的文档

{
  "_index": "sanguo",
  "_type": "_doc",
  "_id": "1",
  "_version": 1,
  "result": "not_found",
  "_shards": {
    "total": 2,
    "successful": 1,
    "failed": 0
  },
  "_seq_no": 9,
  "_primary_term": 1
}

条件删除文档

一般删除数据都是根据文档的唯一性标识进行删除,实际操作时,也可以根据条件对多条数据进行删除

向 ES 服务器发 POST 请求 :http://10.10.10.113:9200/sanguo/_delete_by_query

请求体内容为:

{
  "query": {
    "match":{ 
      "country": "魏"
    }
  }
}

返回体为：

{
  "took": 943,
  "timed_out": false,
  "total"【总数】: 2,
  "deleted"【删除数量】: 2,
  "batches": 1,
  "version_conflicts": 0,
  "noops": 0,
  "retries": {
    "bulk": 0,
    "search": 0
  },
  "throttled_millis": 0,
  "requests_per_second": -1.0,
  "throttled_until_millis": 0,
  "failures": []
}

映射操作

有了索引库,等于有了数据库中的 database。

接下来就需要建索引库(index)中的映射了,类似于数据库(database)中的表结构(table)。创建数据库表需要设置字段名称,类型,长度,约束等;索引库也一样,需要知道这个类型下有哪些字段,每个字段有哪些约束信息,这就叫做映射(mapping)。

创建映射

向 ES 服务器发 PUT 请求 :http://10.10.10.113:9200/student/_mapping

{
    "properties": {
        "name":{
            "type": "text",
            "index": true
        },
        "sex":{
            "type": "keyword",
            "index": true
        },
        "age":{
            "type": "long",
            "index": false
        }
    }
}

映射数据说明:

字段名:任意填写,下面指定许多属性,例如:name、sex、age、price

type:类型,Elasticsearch 中支持的数据类型非常丰富,说几个关键的:

String 类型,又分两种： text:可分词、keyword:不可分词,数据会作为完整字段进行匹配
Numerical:数值类型,分两类：基本数据类型:long、integer、short、byte、double、float、half_float；浮点数的高精度类型:scaled_float
Date:日期类型
Array:数组类型
Object:对象

index:是否索引,默认为 true,也就是说你不进行任何配置,所有字段都会被索引。true:字段会被索引,则可以用来进行搜索，false:字段不会被索引,不能用来搜索

store:是否将数据进行独立存储,默认为 false，原始的文本会存储在_source 里面,默认情况下其他提取出来的字段都不是独立存储的,是从_source 里面提取出来的。当然你也可以独立的存储某个字段,只要设置"store": true 即可,获取独立存储的字段要比从_source 中解析快得多,但是也会占用更多的空间,所以要根据实际业务需求来设置。

analyzer:分词器,这里的 ik_max_word 即使用 ik 分词器

查看映射

向 ES 服务器发 GET 请求 :http://10.10.10.113:9200/student/_mapping

结果如下

{
  "user": {
    "mappings": {
      "properties": {
        "age": {
          "type": "long",
          "index": false
        },
        "name": {
          "type": "text"
        },
        "sex": {
          "type": "keyword"
        }
      }
    }
  }
}

索引映射关联

同时创建好映射和索引

向 ES 服务器发 PUT 请求 :http://10.10.10.113:9200/user1

{
    "settings": {},
    "mappings": {
        "properties": {
            "name":{
                "type": "text",
                "index": true
            },
            "sex":{
                "type": "keyword",
                "index": true
            },
            "age":{
                "type": "long",
                "index": false
            }
        }
    }
}

魔笛Love

关注

0
点赞
踩
1

收藏

觉得还不错? 一键收藏
0
评论
Elasticsearch-RestFul（HTTP）基本操作

Elasticsearch 基本操作RESTfulREST 指的是一组架构约束条件和原则。满足这些约束条件和原则的应用程序或设计就是 RESTful。Web 应用程序最重要的 REST 原则是,客户端和服务器之间的交互在请求之间是无状态的。从客户端到服务器的每个请求都必须包含理解请求所必需的信息。如果服务器在请求之间的任何时间点重启,客户端不会得到通知。此外,无状态请求可以由任何可用服务器回答,这十分适合云计算之类的环境。客户端可以缓存数据以改进性能。在服务器端,应用程序状态和功能可以分为各种资源。资
复制链接

扫一扫