Skip to content

Commit d30155d

Browse files
[DOCS] Updates docs/helpers.asciidoc
Co-authored-by: István Zoltán Szabó <[email protected]>
1 parent 3f64f0b commit d30155d

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

docs/helpers.asciidoc

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -162,9 +162,10 @@ scroll_helper.clear
162162
--
163163

164164
[discrete]
165+
[[esql-helper]]
165166
=== ES|QL Helper
166167

167-
This helpers provides an Object response from the ESQL `query` API instead of the default JSON value.
168+
This helper provides an object response from the ESQL `query` API instead of the default JSON value.
168169

169170
To use the ES|QL helper, require it in your code:
170171

@@ -203,7 +204,7 @@ puts response
203204
]}
204205
----
205206

206-
The helper returns an Array of hashes with the columns as keys and the respective values. So for the previous example, it would return the following:
207+
The helper returns an array of hashes with the columns as keys and the respective values. So for the previous example, it would return the following:
207208

208209
[source,ruby]
209210
----
@@ -222,7 +223,7 @@ puts response
222223
]
223224
----
224225

225-
Additionally, a block can be specified to work on the response data. Pass in a block to `query` and it will yield each item in the Array of responses.
226+
Additionally, a block can be specified to transform the response data. Pass in a block to `query` and it will yield each item in the array of responses.
226227

227228
You could use this for example to convert '@timestamp' into a DateTime object:
228229
[source,ruby]

0 commit comments

Comments
 (0)