Skip to content

Commit 2287654

Browse files
committed
[FEATURE] Add cache:flushtags CLI command
Resolves: TYPO3-Documentation/Changelog-To-Doc#1410 Releases: main
1 parent 65314b4 commit 2287654

File tree

1 file changed

+22
-1
lines changed
  • Documentation/ApiOverview/CachingFramework/Architecture

1 file changed

+22
-1
lines changed

Documentation/ApiOverview/CachingFramework/Architecture/Index.rst

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,11 @@ lifetime
2929

3030
tags
3131
Additional tags (an array of strings) assigned to the entry. It is used to
32-
remove specific cache entries.
32+
remove specific cache entries. The cache can be flushed by tag using command
33+
`vendor/bin/typo3 cache:flushtags <tag>`.
34+
35+
.. versionadded:: 14.0
36+
Command `vendor/bin/typo3 cache:flushtags <tag>` has been introduced
3337

3438
.. tip::
3539
The difference between identifier and tags is quite simple: an identifier
@@ -92,6 +96,9 @@ can be retrieved from the system quickly.
9296
About tags
9397
----------
9498

99+
.. versionadded:: 14.0
100+
Command `vendor/bin/typo3 cache:flushtags <tag>` has been introduced
101+
95102
Tags are used to drop specific cache entries when some information they are
96103
based on is changed.
97104

@@ -118,6 +125,20 @@ an arbitrary number of tags can be assigned to an entry and one specific tag
118125
can be assigned to multiple cache entries. All tags a cache entry has are given
119126
to the cache when the entry is stored ("set").
120127

128+
Command `cache:flushtags` allows flushing cache entries by tag.
129+
130+
Multiple tags can be flushed by passing a comma-separated list of tags.
131+
It is also possible to flush tags for a specific cache group by using the
132+
`--groups` or `-g` option. If no group is specified, all cache groups
133+
are considered.
134+
135+
.. code-block:: bash
136+
:caption: Example command usage (Composer-mode projects)
137+
138+
vendor/bin/typo3 cache:flushtags pageId_123
139+
vendor/bin/typo3 cache:flushtags pages_100,pages_200
140+
vendor/bin/typo3 cache:flushtags tx_news -g pages
141+
121142
.. seealso::
122143
:ref:`Frontend cache collector <typo3-request-attribute-frontend-cache-collector>`
123144

0 commit comments

Comments
 (0)