安装

编辑

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

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

npm install @elastic/elasticsearch

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

npm install @elastic/elasticsearch@<major>

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

Node.js 支持

编辑

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

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

为了避免支持不安全且不受支持的 Node.js 版本,客户端 将在次要版本之间放弃对 EOL 版本 Node.js 的支持。通常,一旦 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 客户端版本不会自动支持 8.13 版本 Elasticsearch 的新功能,为此需要 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 实例暴露给所有人,这可能会导致安全问题。我们建议您编写一个使用此客户端的轻量级代理,您可以在此处查看代理示例。