Skip to content

ES|QL query builder #2997

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
Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

ES|QL query builder #2997

wants to merge 9 commits into from

Conversation

miguelgrinberg
Copy link
Contributor

@miguelgrinberg miguelgrinberg commented Jul 1, 2025 •
edited
Loading

This PR adds a Python ES|QL query builder.

  • Implement all ES|QL commands
  • Add docstrings
  • Integration with DSL module --> Will be implemented later in a separate PR.
  • API documentation
  • Client documentation
  • Unit tests
  • Integration tests

@github-actions GitHub Actions
Copy link

github-actions bot commented Jul 23, 2025 •
edited
Loading

🔍 Preview links for changed docs

@miguelgrinberg miguelgrinberg requested a review from pquentin July 24, 2025 14:18
@miguelgrinberg
Copy link
Contributor Author

miguelgrinberg commented Jul 24, 2025 •
edited
Loading

@pquentin this PR is ready for review. There are currently two remaining items:

  • The 3.8 integration tests continue to fail, unrelated to this change. There are 10 tests that fail, always the same ones, since the 15th. I haven't been able to figure out the cause, but all the failures seem to be related to indices that for some reason weren't wiped and consequently have more documents than expected or fail to be created again. In one of the 10 failures there is a permission failure when attempting to wipe an index, but the user is elastic, so I'm not quite follow why. For now I'm ignoring this problem.
  • I'm not going to write a full integration with the DSL module for the 9.1 release, as I don't want to rush this solution, which is not a trivial one. It is possible to do a lightweight integration by passing index or field names (as you can see in some of the tests), but what's missing is the ability to run an ES|QL query directly from a document class, which I'm going to design with more time.

@miguelgrinberg miguelgrinberg marked this pull request as ready for review July 24, 2025 14:27
miguelgrinberg
miguelgrinberg commented Jul 24, 2025
View reviewed changes
docs/reference/esql-query-builder.md
```python
>>> from elasticsearch import Elasticsearch
>>> client = Elasticsearch(hosts=[os.environ['ELASTICSEARCH_URL']])
>>> response = client.esql.query(query=str(query))
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm not sure what your thoughts are about being able to pass the query object directly here and have the conversion to string in the generated method. Maybe something we can think about for the future as an improvement.

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

@pquentin pquentin Awaiting requested review from pquentin

At least 1 approving review is required to merge this pull request.

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

Successfully merging this pull request may close these issues.
1 participant
@miguelgrinberg