简介编辑

这是 Elasticsearch 的官方 Node.js 客户端。本页简要概述了该客户端的功能。

功能编辑

  • 与 REST API 一对一映射。
  • 通用的、可插拔的架构。
  • 可配置的、自动发现集群节点。
  • 持久的、保持活动连接。
  • 跨所有可用节点的负载均衡。
  • 支持子客户端。
  • 开箱即用的 TypeScript 支持。

安装多个版本编辑

如果您使用多个版本的 Elasticsearch,则还需要使用多个版本的客户端。过去,无法安装同一个软件包的多个版本,但使用 npm v6.9,您可以通过别名来实现。

要安装不同版本的客户端,请运行以下命令

npm install <alias>@npm:@elastic/elasticsearch@<version>

例如,如果您需要安装 7.x6.x,请运行以下命令

npm install es6@npm:@elastic/elasticsearch@6
npm install es7@npm:@elastic/elasticsearch@7

您的 package.json 将类似于以下示例

"dependencies": {
  "es6": "npm:@elastic/elasticsearch@^6.7.0",
  "es7": "npm:@elastic/elasticsearch@^7.0.0"
}

使用您定义的别名从代码中引用软件包。

const { Client: Client6 } = require('es6')
const { Client: Client7 } = require('es7')

const client6 = new Client6({
  cloud: { id: '<cloud-id>' },
  auth: { apiKey: 'base64EncodedKey' }
})
const client7 = new Client7({
  cloud: { id: '<cloud-id>' },
  auth: { apiKey: 'base64EncodedKey' }
})

client6.info().then(console.log, console.log)
client7.info().then(console.log, console.log)

最后,如果您想为下一个版本的 Elasticsearch(位于 Elasticsearch 主分支中的版本)安装客户端,请使用以下命令

npm install esmain@github:elastic/elasticsearch-js

此命令将安装客户端的主分支,该分支不被视为稳定版本。