Added 'chunk' method.

taylorotwell · taylorotwell · commit 11d3e9850dc6 · 2013-09-19T10:35:06.000-05:00
Added 'chunk' method to query builder and Eloquent for doing work on
large result sets.
diff --git a/src/Illuminate/Database/Eloquent/Builder.php b/src/Illuminate/Database/Eloquent/Builder.php
@@ -136,6 +136,30 @@ public function pluck($column)
 		if ($result) return $result->{$column};
 	}
 
+	/**
+	 * Chunk the results of the query.
+	 *
+	 * @param  int  $count
+	 * @param  callable  $callback
+	 * @return void
+	 */
+	public function chunk($count, $callback)
+	{
+		$results = $this->forPage($page = 1, $count)->get();
+
+		while (count($results) > 0)
+		{
+			// On each chunk result set, we will pass them to the callback and then let the
+			// developer take care of everything within the callback, which allows us to
+			// keep the memory low for spinning through large result sets for working.
+			call_user_func($callback, $results);
+
+			$page++;
+
+			$results = $this->forPage($page, $count)->get();
+		}
+	}
+
 	/**
 	 * Get an array with the values of a given column.
 	 *
diff --git a/src/Illuminate/Database/Query/Builder.php b/src/Illuminate/Database/Query/Builder.php
@@ -1074,6 +1074,30 @@ protected function getCacheCallback($columns)
 		return function() use ($me, $columns) { return $me->getFresh($columns); };
 	}
 
+	/**
+	 * Chunk the results of the query.
+	 *
+	 * @param  int  $count
+	 * @param  callable  $callback
+	 * @return void
+	 */
+	public function chunk($count, $callback)
+	{
+		$results = $this->forPage($page = 1, $count)->get();
+
+		while (count($results) > 0)
+		{
+			// On each chunk result set, we will pass them to the callback and then let the
+			// developer take care of everything within the callback, which allows us to
+			// keep the memory low for spinning through large result sets for working.
+			call_user_func($callback, $results);
+
+			$page++;
+
+			$results = $this->forPage($page, $count)->get();
+		}
+	}
+
 	/**
 	 * Get an array with the values of a given column.
 	 *
diff --git a/src/Illuminate/Foundation/changes.json b/src/Illuminate/Foundation/changes.json
@@ -34,6 +34,7 @@
 		{"message": "Allow connection to be configurable when using Redis based sessions.", "backport": null},
 		{"message": "Allow passing DateTime objects to Queue::later.", "backport": null},
 		{"message": "Added Queue::bulk method for pushing several jobs out at once.", "backport": null},
-		{"message": "Added 'dates' property to Eloquent model for convenient setting of date columns.", "backport": null}
+		{"message": "Added 'dates' property to Eloquent model for convenient setting of date columns.", "backport": null},
+		{"message": "Added 'chunk' method to query builder and Eloquent for doing work on large result sets.", "backport": null}
 	]
 }

Original file line number	Diff line number	Diff line change
`@@ -34,6 +34,7 @@`
`34`	`34`	`{"message": "Allow connection to be configurable when using Redis based sessions.", "backport": null},`
`35`	`35`	`{"message": "Allow passing DateTime objects to Queue::later.", "backport": null},`
`36`	`36`	`{"message": "Added Queue::bulk method for pushing several jobs out at once.", "backport": null},`
`37`		`- {"message": "Added 'dates' property to Eloquent model for convenient setting of date columns.", "backport": null}`
	`37`	`+ {"message": "Added 'dates' property to Eloquent model for convenient setting of date columns.", "backport": null},`
	`38`	`+ {"message": "Added 'chunk' method to query builder and Eloquent for doing work on large result sets.", "backport": null}`
`38`	`39`	`]`
`39`	`40`	`}`