Skip to content

Clarify Elasticsearch 9.x compatibility #2928

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

Jump to bottom
Merged
merged 5 commits into from
Apr 17, 2025
Merged

Clarify Elasticsearch 9.x compatibility #2928

merged 5 commits into from
Apr 17, 2025

Conversation

ZachBrisson-Elastic
Copy link
Contributor

@ZachBrisson-Elastic ZachBrisson-Elastic commented Apr 16, 2025 •
edited
Loading

Appended the client compatibility matrix to call out the 9.x client compatibility for 9.x release.

Based off @miguelgrinberg post here #2927 (comment) and past historical precedent, updated the matrix to show that 9.x clients work with 9.x clients and not 8.x or 7.x as they will run into Invalid media-type value on headers errors. You might need someone from the python api team to review prior to approval on this one in case that has changed.

Screenshot showing elasticsearch9 is a valid upgrade/install path
ElasticSupport 2025-04-16 at 11 01 23

ZachBrisson-Elastic and others added 2 commits April 16, 2025 10:58
@ZachBrisson-Elastic
Update index.md
6a6448f 
Appended the client compatibility matrix to call out the 9.x client compatibility for 9.x release.
@pquentin
Update compatibility matrix wording
37b63f3
@pquentin pquentin changed the title Update index.md Clarify Elasticsearch 9.x compatibility Apr 16, 2025
marciw
marciw reviewed Apr 16, 2025
View reviewed changes
Copy link
Contributor

@marciw marciw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I gave this an edit for clarity and flow, at @pquentin's request 🙂

Let me know if you'd prefer I push a commit

README.md Outdated
| 8.x | 8.x | 8.x |
| 7.x | 7.x | 7.17 |

Language clients are forward compatible; meaning that the clients support communicating with greater or equal minor versions of {{es}} without breaking. It does not mean that the clients automatically support new features of newer {{es}} versions; it is only possible after a release of a new client version. For example, a 8.12 client version won’t automatically support the new features of the 8.13 version of {{es}}, the 8.13 client version is required for that. {{es}} language clients are only backwards compatible across minor versions with default distributions and without guarantees made. To upgrade to a new major version, you first need to upgrade Elasticsearch, then the Python Elasticsearch client.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think these {{es}} substitutions will work in the README, right? Only in the docs.

The edits I'm suggesting to the docs also apply to the README, except of course the :::{{tip}} block won't work in the README, so that can just be a standard paragraph.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, I converted to GitHub-flavored Markdown, which also supports alert blocks:

Screenshot 2025-04-17 at 13 30 02

@marciw
Copy link
Contributor

marciw commented Apr 16, 2025

Realized I misstated something, so I made edits to my suggestions (as well as the screenshot) -- done now!

pquentin
pquentin approved these changes Apr 17, 2025
View reviewed changes
Copy link
Member

@pquentin pquentin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @ZachBrisson-Elastic and @marciw!

@pquentin pquentin merged commit bd612f3 into main Apr 17, 2025
20 of 21 checks passed
@pquentin pquentin deleted the ZachBrisson-Elastic-patch-1 branch April 17, 2025 09:32
github-actions bot pushed a commit that referenced this pull request Apr 17, 2025
@ZachBrisson-Elastic @pquentin
@marciw @github-actions
Clarify Elasticsearch 9.x compatibility (#2928)
09e6afa 
Co-authored-by: Quentin Pradet <[email protected]>
Co-authored-by: Marci W <[email protected]>
(cherry picked from commit bd612f3)
@github-actions github-actions bot mentioned this pull request Apr 17, 2025
Merged
pquentin pushed a commit that referenced this pull request Apr 17, 2025
@github-actions @ZachBrisson-Elastic
Clarify Elasticsearch 9.x compatibility (#2928) (#2931)
d89f3bb 
Co-authored-by: Quentin Pradet <[email protected]>
Co-authored-by: Marci W <[email protected]>
(cherry picked from commit bd612f3)

Co-authored-by: Zach Brisson <[email protected]>
@kingbuzzman
Copy link

@pquentin Hi, just want to get a little more details, according to this and this, elasticsearch 7-9 are supported. But in your table, I see no mention of version 7, is this still supported? If so what version?

@pquentin
Copy link
Member

@kingbuzzman Correct, version 7 of the elasticsearch-py client is still supported for a few more months. You can use pip install "elasticsearch>=7,<8" to get the latest 7.x version (7.17.12 at the time of writing).

@kingbuzzman
Copy link

kingbuzzman commented Aug 20, 2025 •
edited
Loading

I see so py version is tied to es version -- with the exception py9 that is also compatible with es8 🤔

Do you suggest instead doing pip install elasticsearch7 vs pip install elasticsearch>=7,<8?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@marciw marciw marciw left review comments

@pquentin pquentin pquentin approved these changes

@miguelgrinberg miguelgrinberg miguelgrinberg approved these changes

Assignees
No one assigned
Labels
backport 9.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@ZachBrisson-Elastic @marciw @kingbuzzman @pquentin @miguelgrinberg