Skip to content

Update note on supported Elasticsearch versions to include 8.4+ #2151

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 28, 2025
Merged

Update note on supported Elasticsearch versions to include 8.4+ #2151

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2fdcd1b
Update note on supported Elasticsearch versions
turegjorup Mar 28, 2025
11ce8fb
Update note to exclude ES 9 (currently in RC status)
turegjorup Mar 28, 2025
c8f17b6
Remove space at end of line
turegjorup Mar 28, 2025
dd43442
Update core/elasticsearch.md
alanpoulain Mar 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions core/elasticsearch.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,19 @@ application search, security analytics, metrics, logging, etc.
API Platform comes natively with the **reading** support for Elasticsearch. It uses internally the official PHP client
for Elasticsearch: [Elasticsearch-PHP](https://www.elastic.co/guide/en/elasticsearch/client/php-api/current/index.html).

Be careful, API Platform only supports Elasticsearch >= 7.11.0 < 8.0.
Be careful, API Platform only supports Elasticsearch >= 7.11.0 < 8.0 and Elasticsearch >= 8.4 < 9.0. Support for
Elasticsearch 8 was introduced in API Platform 3.2.

## Enabling Reading Support

To enable the reading support for Elasticsearch, simply require the Elasticsearch-PHP package using Composer:
To enable the reading support for Elasticsearch, simply require the Elasticsearch-PHP package using Composer. For
Elasticsearch 8:

```console
composer require elasticsearch/elasticsearch:^8.4
```

For Elasticsearch 7:
```console
composer require elasticsearch/elasticsearch:^7.11
```
Expand Down