Skip to content

docs: document the MongoDB ODM HTTP cache purge listener #2362

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
soyuka merged 1 commit into from
Oct 19, 2026
Merged

docs: document the MongoDB ODM HTTP cache purge listener #2362

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
8 changes: 8 additions & 0 deletions core/performance.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,14 @@ proxy’s cache. This ensures that the content served will always be fresh becau
in real time. Support for most specific cases such as the invalidation of collections when a
document is added or removed or for relationships and inverse relations is built-in.

The purge listener is registered automatically for Doctrine ORM. Since API Platform 5.1, when
`doctrine_mongodb_odm` is enabled, a MongoDB ODM listener
(`api_platform.doctrine_mongodb.odm.listener.http_cache.purge`, tagged
`doctrine_mongodb.odm.event_listener`) is registered as well. It purges the collection and item IRIs
of inserted, updated, upserted, and deleted documents, along with their referenced documents
(previous and current values, and members removed from reference collections). Inserts purge the
collection IRI only.

### Integrations

#### Built-in Caddy HTTP Cache
Expand Down
Loading