Skip to content

Making async esql responses binary #3639

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.

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 1 commit into from
Jan 29, 2025
Merged

Making async esql responses binary #3639

merged 1 commit into from
Jan 29, 2025

Conversation

l-trotta
Copy link
Contributor

The esql async API response format varies depending on the format chosen in the request, also it's not supported when using formats that are not json compatible (so it only supported by json, yaml, cbor, smile). The spec as it is only supports json results, so all the responses should be changed to a binary representation, and the clients will choose which to support.

In the backports PR the package change for EsqlFormat will be reversed, as it is a breaking change that we can introduce in the next major.

Copy link
Contributor

Following you can find the validation results for the APIs you have changed.

API Status Request Response
esql.async_query_get Missing test Missing test
esql.async_query Missing test Missing test
esql.query 281/281 Missing test

You can validate these APIs yourself by using the make validate target.

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.

Thanks! LGTM. Do we need approval from other maintainers?

@l-trotta l-trotta merged commit 98f0633 into main Jan 29, 2025
12 checks passed
@l-trotta l-trotta deleted the async-esql-type-change branch January 29, 2025 13:48
github-actions bot pushed a commit that referenced this pull request Jan 29, 2025
(cherry picked from commit 98f0633)
github-actions bot pushed a commit that referenced this pull request Jan 29, 2025
(cherry picked from commit 98f0633)
l-trotta added a commit that referenced this pull request Jan 29, 2025
* making response binary (#3639)

(cherry picked from commit 98f0633)

* change back esql format package

---------

Co-authored-by: Laura Trotta <[email protected]>
Co-authored-by: Laura Trotta <[email protected]>
l-trotta added a commit that referenced this pull request Jan 29, 2025
* making response binary (#3639)

(cherry picked from commit 98f0633)

* change back esql format package

---------

Co-authored-by: Laura Trotta <[email protected]>
Co-authored-by: Laura Trotta <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants