File tree Expand file tree Collapse file tree 4 files changed +19
-19
lines changed Expand file tree Collapse file tree 4 files changed +19
-19
lines changed Original file line number Diff line number Diff line change 1
1
[[esql]]
2
- == ES|QL in the PHP client
2
+ === ES|QL in the PHP client
3
3
++++
4
- <titleabbrev>Using ES|QL</titleabbrev>
4
+ <titleabbrev>ES|QL</titleabbrev>
5
5
++++
6
6
7
7
This page helps you understand and use {ref}/esql.html[ES|QL] in the
Original file line number Diff line number Diff line change
1
+ [[client-helpers]]
2
+ == Client helpers
3
+
4
+ The PHP client comes with the following helpers:
5
+
6
+ * <<iterators>>
7
+ * <<esql>>
8
+
9
+ include::iterators.asciidoc[]
10
+ include::esql.asciidoc[]
Original file line number Diff line number Diff line change 1
- [[client-helpers]]
2
- == Client helpers
3
-
4
- The client comes with helpers to give you a more comfortable experience with
5
- some APIs.
6
-
7
-
8
- [discrete]
9
1
[[iterators]]
10
2
=== Iterators
11
3
4
+ The PHP client includes helpers for iterating through results by page or by hits.
12
5
13
- [discrete]
14
6
[[search-response-iterator]]
15
7
==== Search response iterator
16
8
17
- The `SearchResponseIterator` can be used to iterate page by page in a search
9
+ Use the `SearchResponseIterator` to iterate page by page in a search
18
10
result using
19
11
https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#paginate-search-results[pagination].
20
12
21
- An example as follows :
13
+ Here's an example :
22
14
23
15
[source,php]
24
16
----
@@ -50,11 +42,11 @@ foreach($pages as $page) {
50
42
[[search-hit-iterator]]
51
43
==== Search hit iterator
52
44
53
- The `SearchHitIterator` can be used to iterate in a `SearchResponseIterator`
45
+ Use the `SearchHitIterator` to iterate in a `SearchResponseIterator`
54
46
without worrying about
55
47
https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#paginate-search-results[pagination].
56
48
57
- An example as follows :
49
+ Here's an example :
58
50
59
51
[source,php]
60
52
----
@@ -81,4 +73,4 @@ foreach($hits as $hit) {
81
73
// e.g. prints the document id
82
74
echo $hit['_id'], PHP_EOL;
83
75
}
84
- ----
76
+ ----
Original file line number Diff line number Diff line change @@ -22,9 +22,7 @@ include::configuration.asciidoc[]
22
22
23
23
include::operations.asciidoc[]
24
24
25
- include::helpers.asciidoc[]
26
-
27
- include::esql.asciidoc[]
25
+ include::helpers/index.asciidoc[]
28
26
29
27
include::release-notes.asciidoc[]
30
28
You can’t perform that action at this time.
0 commit comments