2
2
3
3
# Elasticsearch Node.js client
4
4
5
- [ ![ js-standard-style] ( https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat )] ( http://standardjs.com/ ) [ ![ Build Status] ( https://badge.buildkite.com/15e4246eb268ea78f6e10aa90bce38c1abb0a4489e79f5a0ac.svg )] ( https://buildkite.com/elastic/elasticsearch-javascript-client-integration-tests/builds?branch=main ) [ ![ Node CI] ( https://github.com/elastic/elasticsearch-js/actions/workflows/nodejs.yml/badge.svg )] ( https://github.com/elastic/elasticsearch-js/actions/workflows/nodejs.yml ) [ ![ codecov] ( https://codecov.io/gh/elastic/elasticsearch-js/branch/master/graph/badge.svg )] ( https://codecov.io/gh/elastic/elasticsearch-js ) [ ![ NPM downloads] ( https://img.shields.io/npm/dm/@elastic/elasticsearch.svg?style=flat )] ( https://www.npmjs.com/package/@elastic/elasticsearch )
5
+ [ ![ js-standard-style] ( https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat )] ( http://standardjs.com/ ) [ ![ Build Status] ( https://badge.buildkite.com/15e4246eb268ea78f6e10aa90bce38c1abb0a4489e79f5a0ac.svg )] ( https://buildkite.com/elastic/elasticsearch-javascript-client-integration-tests/builds?branch=main ) [ ![ Node CI] ( https://github.com/elastic/elasticsearch-js/actions/workflows/nodejs.yml/badge.svg )] ( https://github.com/elastic/elasticsearch-js/actions/workflows/nodejs.yml ) [ ![ codecov] ( https://codecov.io/gh/elastic/elasticsearch-js/branch/master/graph/badge.svg )] ( https://codecov.io/gh/elastic/elasticsearch-js ) [ ![ NPM downloads] ( https://img.shields.io/npm/dm/@elastic/elasticsearch.svg?style=flat )] ( https://www.npmjs.com/package/@elastic/elasticsearch )
6
6
7
7
** [ Download the latest version of Elasticsearch] ( https://www.elastic.co/downloads/elasticsearch ) **
8
8
or
@@ -34,11 +34,12 @@ the new features of the 8.13 version of Elasticsearch, the 8.13 client version
34
34
is required for that. Elasticsearch language clients are only backwards
35
35
compatible with default distributions and without guarantees made.
36
36
37
- | Elasticsearch Version | Elasticsearch-JS Branch | Supported |
38
- | --------------------- | ------------------------ | --------- |
39
- | main | main | |
40
- | 8.x | 8.x | 8.x |
41
- | 7.x | 7.x | 7.17 |
37
+ | Elasticsearch Version | Elasticsearch-JS Branch |
38
+ | --------------------- | ----------------------- |
39
+ | main | main |
40
+ | 9.x | 9.x |
41
+ | 8.x | 8.x |
42
+ | 7.x | 7.x |
42
43
43
44
## Usage
44
45
@@ -65,36 +66,20 @@ to support that version for at least another minor release. If you are using the
65
66
with a version of Node.js that will be unsupported soon, you will see a warning
66
67
in your logs (the client will start logging the warning with two minors in advance).
67
68
68
- Unless you are ** always** using a supported version of Node.js,
69
+ Unless you are ** always** using a supported version of Node.js,
69
70
we recommend defining the client dependency in your
70
71
` package.json ` with the ` ~ ` instead of ` ^ ` . In this way, you will lock the
71
72
dependency on the minor release and not the major. (for example, ` ~7.10.0 ` instead
72
73
of ` ^7.10.0 ` ).
73
74
74
- | Node.js Version | Node.js EOL date | End of support |
75
- | --------------- | ------------------| ---------------------- |
76
- | ` 8.x ` | ` December 2019 ` | ` 7.11 ` (early 2021) |
77
- | ` 10.x ` | ` April 2021 ` | ` 7.12 ` (mid 2021) |
78
- | ` 12.x ` | ` April 2022 ` | ` 8.2 ` (early 2022) |
79
- | ` 14.x ` | ` April 2023 ` | ` 8.8 ` (early 2023) |
80
- | ` 16.x ` | ` September 2023 ` | ` 8.11 ` (late 2023) |
81
-
82
- ### Compatibility
83
-
84
- Language clients are forward compatible; meaning that clients support communicating with greater or equal minor versions of Elasticsearch.
85
- Elasticsearch language clients are only backwards compatible with default distributions and without guarantees made.
86
-
87
- | Elasticsearch Version | Client Version |
88
- | --------------------- | ----------------|
89
- | ` 8.x ` | ` 8.x ` |
90
- | ` 7.x ` | ` 7.x ` |
91
- | ` 6.x ` | ` 6.x ` |
92
- | ` 5.x ` | ` 5.x ` |
93
-
94
- To install a specific major of the client, run the following command:
95
- ```
96
- npm install @elastic/elasticsearch@<major>
97
- ```
75
+ | Node.js Version | Node.js EOL date | End of support |
76
+ | --------------- | ---------------- | ------------------- |
77
+ | ` 8.x ` | ` December 2019 ` | ` 7.11 ` (early 2021) |
78
+ | ` 10.x ` | ` April 2021 ` | ` 7.12 ` (mid 2021) |
79
+ | ` 12.x ` | ` April 2022 ` | ` 8.2 ` (early 2022) |
80
+ | ` 14.x ` | ` April 2023 ` | ` 8.8 ` (early 2023) |
81
+ | ` 16.x ` | ` September 2023 ` | ` 8.11 ` (late 2023) |
82
+ | ` 18.x ` | ` April 2025 ` | ` 9.2 ` (late 2025) |
98
83
99
84
#### Browser
100
85
@@ -117,6 +102,7 @@ We recommend that you write a lightweight proxy that uses this client instead, y
117
102
* [ Examples] ( https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/examples.html )
118
103
119
104
## Install multiple versions
105
+
120
106
If you are using multiple versions of Elasticsearch, you need to use multiple versions of the client. In the past, install multiple versions of the same package was not possible, but with ` npm v6.9 ` , you can do that via aliasing.
121
107
122
108
The command you must run to install different version of the client is:
0 commit comments