Skip to content

Commit

Permalink
Add ES|QL helper note to changelog (#2249)
Browse files Browse the repository at this point in the history
  • Loading branch information
JoshMock authored May 6, 2024
1 parent 8962168 commit b9ea8f8
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions docs/changelog.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@
[discrete]
==== Features

[discrete]
===== ES|QL object API helper

A helper method has been added that parses the response of an ES|QL query and converts it into an array of objects.
A TypeScript type parameter can also be provided to improve developer experience when working with the result. https://github.com/elastic/elasticsearch-js/pull/2238[#2238]

[discrete]
===== `onSuccess` callback added to bulk helper

Expand Down Expand Up @@ -461,7 +467,7 @@ client.search({ params }, { options }, (err, result) => {
client.search({ params }, { options })
.then(console.log)
.catch(console.log)
// async-style (sugar syntax on top of promises)
const response = await client.search({ params }, { options })
console.log(response)
Expand Down Expand Up @@ -621,7 +627,7 @@ If you weren't extending the internals of the client, this won't be a breaking c

*Breaking: Yes* | *Migration effort: Medium*

Currently, every path or query parameter could be expressed in both `snake_case` and `camelCase`. Internally the client will convert everything to `snake_case`.
Currently, every path or query parameter could be expressed in both `snake_case` and `camelCase`. Internally the client will convert everything to `snake_case`.
This was done in an effort to reduce the friction of migrating from the legacy to the new client, but now it no longer makes sense.
If you are already using `snake_case` keys, this won't be a breaking change for you.

Expand Down

0 comments on commit b9ea8f8

Please sign in to comment.