Skip to content

document pruning and the prune method in readme #3

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 2 commits into from
Sep 29, 2017
Merged

document pruning and the prune method in readme #3

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ca70f7e
document pruning and the prune method in readme
dbu Sep 28, 2017
cc3b158
Minor wording improvements
Toflar Sep 29, 2017
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
16 changes: 15 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ passing an array of `$options` in the constructor:
**Type**: `string`
**Default**: `Cache-Tags`

### Cache Tagging
### Cache tagging

Tag cache entries by adding a response header with the tags as a comma
separated value. By default, that header is called `Cache-Tags`, this can be
Expand All @@ -103,6 +103,20 @@ To invalidate tags, call the method `Psr6Store::invalidateTags` or use the
`PurgeTagsListener` from the [FOSHttpCache][3] library to handle tag
invalidation requests.

### Pruning expired cache entries

By default, this store removes expired entries from the cache after every `500`
cache **write** operations. Fetching data does not affect performance.
You can change the automated pruning frequency with the `prune_threshold`
configuration setting.

You can also manually trigger pruning by calling the `prune()` method on the
cache. With this, you could for example implement a cron job that loads the store
and prunes it at a configured interval, to prevent slowing down random requests
that were cache misses because they have to wait for the pruning to happen. If you
have set up a cron job, you should disable auto pruning by setting the threshold
to `0`.

### WARNING

It is possible to configure other cache adapters or lock stores than the
Expand Down