安装编辑

本页面将指导您完成客户端的安装过程。

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

npm install @elastic/elasticsearch

要安装特定主版本的客户端,请运行以下命令

npm install @elastic/elasticsearch@<major>

要了解有关受支持主版本的更多信息,请参阅 兼容性矩阵

Node.js 支持编辑

支持的 Node.js 最低版本为 v18

客户端版本控制遵循 Elastic Stack 版本控制,这意味着主版本、次版本和补丁版本的发布遵循一个精确的计划,该计划通常与 Node.js 版本发布 时间不一致。

为了避免支持不安全和不受支持的 Node.js 版本,客户端 将在次版本发布之间停止对 Node.js 的 EOL 版本的支持。通常,一旦 Node.js 版本进入 EOL,客户端将继续支持该版本至少另一个次版本。如果您使用的是即将不受支持的 Node.js 版本,您将在日志中看到警告(客户端将开始在提前两个次版本时记录警告)。

除非您 始终 使用受支持的 Node.js 版本,我们建议在您的 package.json 中使用 ~ 而不是 ^ 定义客户端依赖项。这样,您将锁定对次版本而不是主版本的依赖关系。(例如,~7.10.0 而不是 ^7.10.0)。

Node.js 版本 Node.js EOL 日期 支持结束

8.x

2019 年 12 月

7.11(2021 年初)

10.x

2021 年 4 月

7.12(2021 年中)

12.x

2022 年 4 月

8.2(2022 年初)

14.x

2023 年 4 月

8.8(2023 年初)

16.x

2023 年 9 月

8.11(2023 年底)

兼容性矩阵编辑

语言客户端是向前兼容的;这意味着客户端支持与大于或等于 Elasticsearch 次版本的版本进行通信,而不会出现故障。但这并不意味着客户端会自动支持较新 Elasticsearch 版本的新功能;只有在发布新客户端版本后才有可能。例如,8.12 客户端版本不会自动支持 Elasticsearch 8.13 版本的新功能,需要 8.13 客户端版本才能实现。Elasticsearch 语言客户端仅向后兼容默认发行版,并且没有做出任何保证。

Elasticsearch 版本 客户端版本 支持

8.x

8.x

8.x

7.x

7.x

7.17

6.x

6.x

5.x

5.x

浏览器编辑

浏览器环境没有官方支持。它会将您的 Elasticsearch 实例暴露给所有人,这可能会导致安全问题。我们建议您编写一个使用此客户端的轻量级代理,您可以在 此处 查看代理示例。