iterateBatch

Author: asika32764

packages/query/src/Query.php

@@ -1840,6 +1840,46 @@ public function __call(string $name, array $args): mixed
     /**
      * @template T of Collection
      *
+     * Iterate and call DB every N times, every time get full items but yield item one by one, stop when no more items.
+     * This method can ensure no long connection to DB. You only need one level foreach to get every item.
+     *
+     * @param  int                   $length
+     * @param  class-string<T>|null  $class
+     * @param  array                 $args
+     *
+     * @return  Generator<Collection<T>>
+     */
+    public function iterateBatched(int $length, ?string $class = null, array $args = []): \Generator
+    {
+        $offset = 0;
+
+        while (true) {
+            $query = clone $this;
+            $query->offset($offset)->limit($length);
+
+            $items = $query->all($class, $args);
+
+            $count = 0;
+
+            foreach ($items as $item) {
+                $count++;
+                yield $item;
+            }
+
+            if ($count === 0 || $count < $length) {
+                break;
+            }
+
+            $offset += $length;
+        }
+    }
+
+    /**
+     * @template T of Collection
+     *
+     * Iterate and return chunks of items, every chunk will one time return full items.
+     * You need 2 level foreach to get every item.
+     *
      * @param  int                   $length
      * @param  class-string<T>|null  $class
      * @param  array                 $args
@@ -1873,11 +1913,15 @@ public function iterateChunks(int $length, ?string $class = null, array $args =
     /**
      * @template T of Collection
      *
+     * Iterate and call DB N times, every time get innter iterator and yield items one by one, stop when no more items.
+     * This method will not offset or paginated, it will always start from 0.
+     * You must change the item state in the loop to avoid infinite loop.
+     *
      * @param  int                   $length
      * @param  class-string<T>|null  $class
      * @param  array                 $args
      *
-     * @return  Generator<Collection<T>>
+     * @return  Generator<T>
      */
     public function iterateWhile(int $length, ?string $class = null, array $args = []): \Generator
     {
@@ -1900,6 +1944,41 @@ public function iterateWhile(int $length, ?string $class = null, array $args = [
         }
     }
 
+    /**
+     * @template T of Collection
+     *
+     * Iterate and call DB N times, every time get full items and yield items one by one to prevent long connections,
+     * stop when no more items.
+     * This method will not offset or paginated, it will always start from 0.
+     * You must change the item state in the loop to avoid infinite loop.
+     *
+     * @param  int                   $length
+     * @param  class-string<T>|null  $class
+     * @param  array                 $args
+     *
+     * @return  Generator<T>
+     */
+    public function iterateBatchWhile(int $length, ?string $class = null, array $args = []): \Generator
+    {
+        $query = clone $this;
+        $query->offset(0)->limit($length);
+
+        while (true) {
+            $items = $query->all($class, $args);
+
+            $count = 0;
+
+            foreach ($items as $item) {
+                $count++;
+                yield $item;
+            }
+
+            if ($count === 0 || $count < $length) {
+                break;
+            }
+        }
+    }
+
     /**
      * @template  T of Collection
      *