Elasticsearch 参考指南（目录）

Elasticsearch 参考指南

Elasticsearch是一个高度可扩展的开源全文搜索和分析引擎，它容许你快速，近实时地存储，搜索和分析大量数据，它一般用做底层引擎/技术，为具备复杂搜索功能和要求的应用程序提供支持。

入门

• 介绍
• 基本概念
• 安装
• 探索你的集群
• 修改你的数据
• 探索你的数据

Elasticsearch既简单又复杂，到目前为止，咱们已经了解了它的基础知识，如何查看它，以及如何使用一些REST API来使用它，但愿本教程能让你更好地了解Elasticsearch的内容，更重要的是，启发你进一步尝试其他的强大功能！

设置Elasticsearch

本节包含有关如何设置Elasticsearch并使其运行的信息，包括：下载，安装，启动，配置。

支持的平台

官方支持的操做系统和JVM矩阵可在此处得到：支持矩阵，Elasticsearch在列出的平台上进行了测试，但它也可能在其余平台上运行。

• 安装Elasticsearch

  • 使用.zip或.tar.gz安装Elasticsearch
  • 使用.zip在Windows上安装Elasticsearch
  • 使用Debian软件包安装Elasticsearch
  • 使用RPM安装Elasticsearch
  • 使用Windows MSI安装程序安装Elasticsearch
  • 使用Docker安装Elasticsearch
• 配置Elasticsearch
• 重要的Elasticsearch配置
• 重要的系统配置
• 引导检查
• 启动Elasticsearch
• 中止Elasticsearch
• 安装X-Pack
• 配置监控
• 配置安全性
• 配置X-Pack Java客户端
• X-Pack设置
• 引导检查X-Pack

升级Elasticsearch

• 滚动升级
• 完整集群重启升级
• 升级前重建索引

API约定

Elasticsearch经过HTTP使用JSON公开REST API。

除非另有说明，本章列出的约定能够在整个REST API中应用。

• 多索引
• 索引名中的日期公式支持
• 通用选项

基于URL的访问控制

许多用户使用基于url的访问控制的代理来安全访问Elasticsearch索引，对于多搜索、多获取和批量请求，用户能够选择在URL中以及在请求体中的每一个请求上指定索引，这可能使基于url的访问控制具备挑战性。

为了防止用户覆盖URL中指定的索引，将此设置添加到elasticsearch.yml文件中：

rest.action.multi.allow_explicit_index: false

默认值为true，但当设置为false时，Elasticsearch将拒绝在请求体中指定的显式索引的请求。

文档 API

本节首先简要介绍Elasticsearch的数据复制模型，而后详细介绍如下CRUD API。

全部CRUD API都是单索引API， index参数接受单个索引名，或指向单个索引的别名。

• 读和写文档
• Index API
• Get API
• Delete API
• Delete By Query API
• Update API
• Update By Query API
• Multi Get API
• Bulk API
• Reindex API
• Term Vectors
• Multi termvectors API
• ?refresh

搜索 API

• Search API
• URI搜索
• 请求体搜索
• 搜索模板
• 批量搜索模板
• 搜索碎片API
• Suggesters
• 多搜索API
• Count API
• 验证API
• 解释API
• 分析API
• Field Capabilities API
• 排名评估API

聚合

• 聚合介绍

指标聚合

这个系列中的聚合基于以某种方式从正在聚合的文档中提取的值计算指标，这些值一般从文档的字段中提取（使用字段数据），但也可使用脚本生成。

数值指标聚合是输出数值的一种特殊类型的指标聚合，一些聚合输出单个数值指标（例如avg），称为single-value numeric metrics aggregation，另外一些聚合生成多个指标（例如stats），称为multi-value numeric metrics aggregation，当这些聚合充当一些桶聚合的直接子聚合时，单值和多值数字指标聚合之间的区别就发挥了做用（一些桶聚合使你可以根据每一个桶中的数字指标对返回的桶进行排序）。

• Avg聚合
• 加权平均聚合
• 基数聚合
• 扩展的统计聚合
• 地理边界聚合
• 地理重心聚合
• Max聚合

桶聚合

桶聚合不像指标聚合那样在字段上计算指标，而是建立文档桶，每一个桶都与一个标准相关联（取决于聚合类型），这决定当前上下文中的文档是否“落入”它，换句话说，桶有效地定义了文档集，除了桶自己以外，bucket聚合还计算并返回“落入”每一个桶中的文档数量。

与metrics聚合相反，桶聚合能够包含子聚合，这些子聚合将聚合它们的“父”桶聚合建立的桶。

有不一样的桶聚合器，每一个聚合器都有不一样的“bucketing”策略，一些定义单个桶，一些定义固定数量的多个桶，还有一些在聚合过程当中动态建立桶。

单个响应中容许的最大桶数受到名为 search.max_buckets的动态集群设置的限制，默认状况下它是禁用的（ -1），可是试图返回超过10,000个桶（将来版本的默认值）的请求将记录一个弃用警告。

• 邻接矩阵聚合
• 子聚合
• 合成聚合
• 日期直方图聚合
• 日期范围聚合
• 多样化的取样器聚合
• 过滤器聚合
• 地理距离聚合
• GeoHash网格聚合
• 全局聚合
• 直方图聚合
• IP范围聚合

---

• 管道聚合

  • Avg桶聚合
  • 导数聚合
  • Max桶聚合
  • Min桶聚合
  • Sum桶聚合

---

• 矩阵聚合
• 缓存重聚合
• 仅返回聚合结果
• 聚合元数据
• 返回聚合的类型

索引API

索引API用于管理各个索引，索引设置，别名，映射和索引模板。

• 建立索引
• 删除索引
• 获取索引
• 索引是否存在
• 打开/关闭索引API
• 收缩索引
• 分割索引
• 滚动索引
• Put Mapping
• 获取映射
• 获取字段映射
• 类型是否存在
• 索引别名
• 更新索引设置
• 获取设置
• 分析
• 索引模板
• 索引统计
• 索引段
• 索引恢复
• 索引碎片存储
• 清除缓存
• Flush
• 刷新
• 强制合并

cat API

• cat别名
• cat分配
• cat count
• cat字段数据
• cat健康
• cat索引
• cat master
• cat nodeattrs
• cat节点
• cat挂起的任务
• cat插件
• cat recovery
• cat仓库
• cat线程池
• cat碎片
• cat片断
• cat快照
• cat模版

集群API

• 集群健康
• 集群状态
• 集群统计
• 待处理的集群任务
• 集群从新路由
• 集群更新设置
• 集群获取设置
• 节点统计
• 节点信息
• 节点特性用法
• 远程集群信息
• 任务管理API
• 节点hot_threads
• 集群分配解释API

查询DSL

Elasticsearch提供基于JSON的完整的查询DSL（领域特定语言）来定义查询，将查询DSL看做查询的AST（抽象语法树），由两种类型的子句组成：

叶查询子句 - 叶查询子句查找特定字段中的特定值，例如match、term或range查询，这些查询能够被它本身使用。

复合查询子句 - 复合查询子句包装其余叶子或复合查询，并用于以逻辑方式组合多个查询（如bool或dis_max查询），或更改其行为（如constant_score查询）。

查询子句的行为取决于它们是用于查询上下文仍是过滤器上下文。

• 查询和过滤器上下文
• 匹配全部查询
• 全文查询
• Term级别查询
• 复合查询
• Joining查询
• 地理查询
• 专业的查询
• 跨度查询
• Minimum Should Match
• 多项查询重写

映射

• 映射
• 删除映射类型
• 字段数据类型
• 元字段
• 映射参数
• 动态映射

分析

• 分析器解析
• 测试分析器
• 分析器
• 正常化
• 分词器
• Token过滤器
• 字符过滤器

模块

• 集群
• 发现
• 本地网关
• HTTP
• 索引
• 网络设置
• 节点
• 插件

• 脚本

  • 如何使用脚本
  • 访问文档字段和特殊变量
  • 脚本和安全性
  • Lucene表达式语言
  • 使用脚本引擎的高级脚本
• 快照和恢复
• 线程池
• 传输
• 部落节点
• 跨集群搜索

索引模块

• 索引模块

SQL访问

• 概述
• 开始使用SQL
• 约定和术语
• 安全
• SQL REST API
• SQL Translate API
• SQL CLI
• SQL JDBC
• SQL语言
• 数据类型
• SQL命令
• 函数和运算符
• 保留关键字

重要更改

• 在6.4中的重要更改

发布说明

• Elasticsearch版本6.4.2