Fix #352: Add support for query parameter search_after to paginate …

…over large datasets
yiisoft · Oct 27, 2024 · 9a33fa7 · 9a33fa7
1 parent 498a28d
commit 9a33fa7
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,7 @@ Yii Framework 2 Elasticsearch extension Change Log
 
 - Bug #344: Disabled JSON pretty print for ElasticSearch bulk API (rhertogh)
 - Bug #350: Remove deprecated code, set $pagination->totalCount (lav45)
+- Bug #352: Add support for query parameter `search_after` to paginate over large datasets (lubosdz)
 
 
 2.1.4 May 22, 2023

diff --git a/src/Query.php b/src/Query.php
@@ -236,6 +236,12 @@ class Query extends Component implements QueryInterface
      * @since 2.0.5
      */
     public $explain;
+    /**
+     * @var array Allows pagination of large datasets.
+     * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/paginate-search-results.html#search-after
+     * @since 2.1.5
+     */
+    public $search_after = [];
 
 
     /**

diff --git a/src/QueryBuilder.php b/src/QueryBuilder.php
@@ -109,6 +109,9 @@ public function build($query)
         if (!empty($query->collapse)) {
             $parts['collapse'] = $query->collapse;
         }
+        if ($query->search_after) {
+            $parts['search_after'] = $query->search_after;
+        }
 
         $sort = $this->buildOrderBy($query->orderBy);
         if (!empty($sort)) {