-
-
Notifications
You must be signed in to change notification settings - Fork 5.2k
[Cache] Add chapter about invalidation, tags, etc. #6947
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
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,89 @@ | ||
.. index:: | ||
single: Cache; Invalidation | ||
single: Cache; Tags | ||
|
||
Cache Invalidation | ||
================== | ||
|
||
Cache invalidation is the process of removing all cached items related to a | ||
change in the state of your model. The most basic kind of invalidation is direct | ||
items deletion. But when the state of a primary resource has spread accross | ||
several cached items, keeping them in sync can be difficult. | ||
|
||
The Symfony Cache component provides two mechanisms to help solve this problem: | ||
|
||
* Tags based invalidation for managing data dependencies; | ||
* Expiration based invalidation for time related dependencies. | ||
|
||
.. versionadded:: 3.2 | ||
Tags based invalidation was introduced in Symfony 3.2. | ||
|
||
Using Cache Tags | ||
---------------- | ||
|
||
To benefit from tags based invalidation, you need to attach the proper tags to | ||
each cached items. Each tag is a plain string identifier that you can use at any | ||
time to trigger the removal of all items that had this tag attached to them. | ||
|
||
To attach tags to cached items, you need to use the | ||
:method:`Symfony\\Component\\Cache\\CacheItem::tag` method that is implemented by | ||
cache items, as returned by cache adapters:: | ||
|
||
$item = $cache->getItem('cache_key'); | ||
// ... | ||
// add one or more tags | ||
$item->tag('tag_1'); | ||
$item->tag(array('tag_2', 'tag_3')); | ||
$cache->save($item); | ||
|
||
If ``$cache`` implements :class:`Symfony\\Component\\Cache\\TagAwareAdapterInterface`, | ||
you can invalidate the cached items by calling | ||
:method:`Symfony\\Component\\Cache\\TagAwareAdapterInterface::invalidateTags`:: | ||
|
||
// invalidate all items related to `tag_2` | ||
$cache->invalidateTags('tag_2'); | ||
|
||
// or invalidate all items related to `tag_1` or `tag_3` | ||
$cache->invalidateTags(array('tag_1', 'tag_3')); | ||
|
||
// if you know the cache key, you can of course delete directly | ||
$cache->deleteItem('cache_key'); | ||
|
||
Using tags invalidation is very useful when tracking cache keys becomes difficult. | ||
|
||
Tag Aware Adapters | ||
~~~~~~~~~~~~~~~~~~ | ||
|
||
To store tags, you need to wrap a cache adapter with the | ||
:class:`Symfony\\Component\\Cache\\Adapter\\TagAwareAdapter` class or implement | ||
:class:`Symfony\\Component\\Cache\\Adapter\\TagAwareAdapterInterface` and its only | ||
:method:`Symfony\\Component\\Cache\\Adapter\\TagAwareAdapterInterface::invalidateTags` | ||
method. | ||
|
||
The :class:`Symfony\\Component\\Cache\\Adapter\\TagAwareAdapter` class implements | ||
instantaneous invalidation (time complexity is ``O(N)`` where ``N`` is the number | ||
of invalidated tags). It needs one or two cache adapters: the first required | ||
one is used to store cached items; the second optional one is used to store tags | ||
and their invalidation version number (conceptually similar to their latest | ||
invalidation date). When only one adapter is used, items and tags are all stored | ||
in the same place. By using two adapters, you can e.g. store some big cached items | ||
on the filesystem or in the database and keep tags in a Redis database to sync all | ||
your fronts and have very fast invalidation checks:: | ||
|
||
use Symfony\Component\Cache\Adapter\TagAwareAdapter; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is a great example and very well explained!! |
||
use Symfony\Component\Cache\Adapter\FilesystemAdapter; | ||
use Symfony\Component\Cache\Adapter\RedisAdapter; | ||
|
||
$cache = new TagAwareAdapter( | ||
// Adapter for cached items | ||
new FilesystemAdapter(), | ||
// Adapter for tags | ||
new RedisAdapter('redis://localhost') | ||
); | ||
|
||
Using Cache Expiration | ||
---------------------- | ||
|
||
If your data is valid only for a limited period of time, you can specify their | ||
lifetime or their expiration date with the PSR-6 interface, as explained in the | ||
:doc:`/components/cache/cache_items` article. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the comment says
tag_1
but the code saystag_2