Skip to content

unbuffered resultsets are no more #7785

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
markstory merged 3 commits into from
Dec 21, 2023
Merged

unbuffered resultsets are no more #7785

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
619730b
unbuffered resultsets are no more
LordSimal Dec 21, 2023
0f501b3
add info about removed resultset buffering toggle to migration docs
LordSimal Dec 21, 2023
9cea138
Update en/appendices/5-0-migration-guide.rst
LordSimal Dec 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions en/appendices/5-0-migration-guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,7 @@ Database
- ``Connection::disconnect()`` has been removed. Use
``$connection->getDriver()->disconnect()`` instead.
- ``cake.database.queries`` has been added as an alternative to the ``queriesLog`` scope
- The ability to enable/disable ResultSet buffering has been removed. Results are always buffered.

Datasource
----------
Expand Down
19 changes: 1 addition & 18 deletions en/orm/retrieving-data-and-resultsets.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -918,24 +918,7 @@ and you can use any collection method on ResultSet objects.

Result set objects will lazily load rows from the underlying prepared statement.
By default results will be buffered in memory allowing you to iterate a result
set multiple times, or cache and iterate the results. If you need work with
a data set that does not fit into memory you can disable buffering on the query
to stream results::

$query->disableBufferedResults();

Turning buffering off has a few caveats:

#. You will not be able to iterate a result set more than once.
#. You will also not be able to iterate & cache the results.
#. Buffering cannot be disabled for queries that eager load hasMany or
belongsToMany associations, as these association types require eagerly
loading all results so that dependent queries can be generated.

.. warning::

Streaming results will still allocate memory for the entire results when
using PostgreSQL and SQL Server. This is due to limitations in PDO.
set multiple times, or cache and iterate the results.

Result sets allow you to cache/serialize or JSON encode results for API
results::
Expand Down