Skip to content

[Cache] Tell about namespace-based invalidation #20957

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
merged 1 commit into from
May 13, 2025
Merged

[Cache] Tell about namespace-based invalidation #20957

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
27 changes: 27 additions & 0 deletions components/cache.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,33 @@ generate and return the value::
Use cache tags to delete more than one key at the time. Read more at
:doc:`/components/cache/cache_invalidation`.

Creating Sub-Namespaces
-----------------------

All cache adapters provided by the component implement the
:method:`Symfony\\Contracts\\Cache\\NamespacedPoolInterface::withSubNamespace` method
from the :class:`Symfony\\Contracts\\Cache\\NamespacedPoolInterface`.

.. versionadded:: 7.3

Support for ``NamespacedPoolInterface`` was added in Symfony 7.3.

This method allows namespacing cached items by transparently prefixing their keys::

$subCache = $cache->withSubNamespace('foo');

$subCache->get('my_cache_key', function (ItemInterface $item): string {
$item->expiresAfter(3600);

return '...';
});

In this example, cache item keyed ``my_cache_key`` will be transparently stored within
the cache pool under a logical namespace called ``foo``.

Sub-namespacing allows implementing namespace-based cache invalidation, where the name
of a namespace is computed by hashing some context info.

.. _cache_stampede-prevention:

Stampede Prevention
Expand Down