Skip to content
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.

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

Add docs for CounterCacheBehavior::updateCounterCache(). #7931

Merged
merged 1 commit into from
Oct 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 7 additions & 0 deletions en/appendices/5-2-migration-guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,13 @@ Behavior Changes
New Features
============

ORM
---

- ``CounterCacheBehavior::updateCounterCache()`` has been addded. This method
allows you to update the counter cache values for all records of the configured
associations.

Error
-----

Expand Down
25 changes: 25 additions & 0 deletions en/orm/behaviors/counter-cache.rst
Original file line number Diff line number Diff line change
Expand Up @@ -162,3 +162,28 @@ with the same code as described above.::
]);

Finally clear all caches with ``bin/cake cache clear_all`` and try it out.

Manually updating counter caches
================================

.. php:method:: updateCounterCache(?string $assocName = null, int $limit = 100, ?int $page = null): void

The ``updateCounterCache()`` method allows you to update the counter cache values
for all records of one or all configured associations in batches. This can be useful,
for example, to update the counter cache after importing data directly into the database.::

// Update the counter cache for all configured associations
$table->updateCounterCache();

// Update the counter cache for a specific association, 200 records per batch
$table->updateCounterCache('Articles', 200);

// Update only the first page of records
$table->updateCounterCache('Articles', page: 1);

.. versionadded:: 5.2.0

.. note::

This methods won't update the counter cache values for fields which are
configured to use a closure to get the count value.