[PR #580] [WIP] Second level cache #8403

New Issue

admin · 2026-01-22T15:59:46+01:00

admin commented

2026-01-22 15:59:46 +01:00

Original Pull Request: https://github.com/doctrine/orm/pull/580

State: closed
Merged: No

Hi guys. :)

After a look into some implementations I end up with the following solution for the second level cache..

There is lot of work todo before merge it, but i'd like to get your thoughts before i go any further on this approach.
I hope my drafts are good enough to explain the idea :

Cache strategies

* READ_ONLY (DEFAULT)   : ReadOnly cache can do reads, inserts and deletes, cannot perform updates or employ any locks.
* NONSTRICT_READ_WRITE  : Nonstrict Read Write Cache doesn’t employ any locks but can do reads, inserts , updates and deletes.
* READ_WRITE            : Read Write cache employs locks the entity before update/delete.

classes / interfaces

Region :
Defines a contract for accessing a entity/collection data cache. (Doesn’t employ any locks)
ConcurrentRegion :
Defines contract for concurrently managed data region. (Locks the data before update/delete.)
CacheKey / EntityCacheKey / CollectionCacheKey/ QueryCacheKey:
Defines entity / collection key to be stored in the cache region.
EntityHidrator / CollectionHidrator
Build cache entries and rebuild entities/colection from cache
CacheFactory
Factory from second level cache components

Collection Caching

The most common use case is to cache entities. But we can also cache relationships.
A “collection cache” caches the primary keys of entities that are members of a collection (OneToMany/ManyToMany).
and each element will be cached into its region.

Only identifiers will be cached for collection. When a collection is read from the second level cache it will create proxies based on the cached identifiers, if the application needs to access an element, Doctrine will go to the cache to load the element data.

Query Cache

The query cache does not cache the state of the actual entities in the result set;
it caches only identifier values for an individual query.
So the query cache should always be used in conjunction with the second-level cache.

Query Cache validation

UpdateTimestampsCacheRegion (hibernate approach) :

The timestamp cache region keeps track of the last update for each table. (updated for each table modification)

A single timestamps region it's utilized by all query cache instances.

In most hibernate cache implementations is recommend do not configured cache timeout at all.

When a query is loaded from cache, the timestamp region is checked for all tables in the query.

If the timestamp of the last update on a table is greater than the time the query results were cached,
Then the entry is removed and the query goes straight to the database.

OPERATIONS

INSERT :

*************************************************************************************************
UnitOfWork#commit
    Connection#beginTransaction
    Persister#executeInserts
    Connection#commit
    CachedPersister#afterTransactionComplete
        -> Region#put
*************************************************************************************************
                    | READ-ONLY             | NONSTRICT-READ-WRITE      | READ-WRITE            |
-------------------------------------------------------------------------------------------------
pre-insert          |                       |                           |                       |
-------------------------------------------------------------------------------------------------
on-insert           |                       |                           |                       |
-------------------------------------------------------------------------------------------------
after-transaction   | add item to the cache | add item to the cache     | add item to the cache |
-------------------------------------------------------------------------------------------------

UPDATE :

*************************************************************************************************
UnitOfWork#commit
    Connection#beginTransaction
    CachedPersister#update
        -> Region#lock
        -> execute
    Connection#commit
    CachedPersister#afterTransactionComplete
        -> Region#put
        -> Region#unlock
*************************************************************************************************
                    | READ-ONLY             | NONSTRICT-READ-WRITE      | READ-WRITE            |
-------------------------------------------------------------------------------------------------
pre-update          |                       |                           | lock item             |
-------------------------------------------------------------------------------------------------
on-update           | throws exception      |                           |                       |
-------------------------------------------------------------------------------------------------
after-transaction   |                       |  update item cache        | remove item cache     |
-------------------------------------------------------------------------------------------------

DELETE :

*************************************************************************************************
UnitOfWork#commit
    Connection#beginTransaction
    CachedPersister#delete
        -> Region#lock
        -> execute
    Connection#commit
    CachedPersister#afterTransactionComplete
        -> Region#evict
*************************************************************************************************
                    | READ-ONLY             | NONSTRICT-READ-WRITE      | READ-WRITE            |
-------------------------------------------------------------------------------------------------
pre-remove          |                       |                           |                       |
-------------------------------------------------------------------------------------------------
on-remove           |                       |                           | lock item             |
-------------------------------------------------------------------------------------------------
after-transaction   | remove item cache     |  remove item cache        | remove item cache     |
-------------------------------------------------------------------------------------------------

USAGE :

<?php

/**
 * @Entity
 * @Cache("NONSTRICT_READ_WRITE")
 */
class State
{
    /**
     * @Id
     * @GeneratedValue
     * @Column(type="integer")
     */
    protected $id;
    /**
     * @Column
     */
    protected $name;
    /**
     * @Cache()
     * @ManyToOne(targetEntity="Country")
     * @JoinColumn(name="country_id", referencedColumnName="id")
     */
    protected $country;
    /**
     * @Cache()
     * @OneToMany(targetEntity="City", mappedBy="state")
     */
    protected $cities;
}

<?php

$em->persist(new State($name, $country));
$em->flush();                                // Put into cache

$em->clear();                                // Clear entity manager

$state   = $em->find('Entity\State', 1);     // Retreive item from cache
$country = $state->getCountry();             // Retreive item from cache
$cities  = $state->getCities();              // Load from database and put into cache

$state->setName("New Name");
$em->persist($state);
$em->flush();                                // Update item cache

$em->clear();                                // Clear entity manager

$em->find('Entity\State', 1)->getCities();   // Retreive from cache


$em->getCache()->containsEntity('Entity\State', $state->getId())  // Check if the cache exists
$em->getCache()->evictEntity('Entity\State', $state->getId());    // Remove an entity from cache
$em->getCache()->evictEntityRegion('Entity\State');               // Remove all entities from cache

$em->getCache()->containsCollection('Entity\State', 'cities', $state->getId());   // Check if the cache exists        
$em->getCache()->evictCollection('Entity\State', 'cities', $state->getId());      // Remove an entity collection from cache
$em->getCache()->evictCollectionRegion('Entity\State', 'cities');                 // Remove all collections from cache

TODO :

Handle many to many collection
Handle inheritance
Remove/add colection items on update
Improve region tests
Improve cached persisters coverage
Implement xml / yml / php drivers
Implement transaction region (Improve cache drivers)
Implement query cache (need more tests)
Read and write region when using query cache
Update documentation
Implement cache cache hits and misses log
.... ????

**Original Pull Request:** https://github.com/doctrine/orm/pull/580 **State:** closed **Merged:** No --- Hi guys. :) After a look into some implementations I end up with the following solution for the second level cache.. There is lot of work todo before merge it, but i'd like to get your thoughts before i go any further on this approach. I hope my drafts are good enough to explain the idea : ### Cache strategies ``` * READ_ONLY (DEFAULT) : ReadOnly cache can do reads, inserts and deletes, cannot perform updates or employ any locks. * NONSTRICT_READ_WRITE : Nonstrict Read Write Cache doesn’t employ any locks but can do reads, inserts , updates and deletes. * READ_WRITE : Read Write cache employs locks the entity before update/delete. ``` ### classes / interfaces - **Region** : Defines a contract for accessing a entity/collection data cache. (Doesn’t employ any locks) - **ConcurrentRegion** : Defines contract for concurrently managed data region. (Locks the data before update/delete.) - **CacheKey / EntityCacheKey / CollectionCacheKey/ QueryCacheKey**: Defines entity / collection key to be stored in the cache region. - **EntityHidrator / CollectionHidrator** Build cache entries and rebuild entities/colection from cache - **CacheFactory** Factory from second level cache components ### Collection Caching The most common use case is to cache entities. But we can also cache relationships. A “collection cache” caches the primary keys of entities that are members of a collection (OneToMany/ManyToMany). and each element will be cached into its region. Only identifiers will be cached for collection. When a collection is read from the second level cache it will create proxies based on the cached identifiers, if the application needs to access an element, Doctrine will go to the cache to load the element data. ### Query Cache The query cache does not cache the state of the actual entities in the result set; it caches only identifier values for an individual query. So the query cache should always be used in conjunction with the second-level cache. #### Query Cache validation > ##### UpdateTimestampsCacheRegion (hibernate approach) : > - The timestamp cache region keeps track of the last update for each table. (updated for each table modification) > - A single timestamps region it's utilized by all query cache instances. > - In most hibernate cache implementations is recommend do not configured cache timeout at all. > - When a query is loaded from cache, the timestamp region is checked for all tables in the query. > - If the timestamp of the last update on a table is greater than the time the query results were cached, > Then the entry is removed and the query goes straight to the database. ### OPERATIONS #### INSERT : ``` ************************************************************************************************* UnitOfWork#commit Connection#beginTransaction Persister#executeInserts Connection#commit CachedPersister#afterTransactionComplete -> Region#put ************************************************************************************************* | READ-ONLY | NONSTRICT-READ-WRITE | READ-WRITE | ------------------------------------------------------------------------------------------------- pre-insert | | | | ------------------------------------------------------------------------------------------------- on-insert | | | | ------------------------------------------------------------------------------------------------- after-transaction | add item to the cache | add item to the cache | add item to the cache | ------------------------------------------------------------------------------------------------- ``` #### UPDATE : ``` ************************************************************************************************* UnitOfWork#commit Connection#beginTransaction CachedPersister#update -> Region#lock -> execute Connection#commit CachedPersister#afterTransactionComplete -> Region#put -> Region#unlock ************************************************************************************************* | READ-ONLY | NONSTRICT-READ-WRITE | READ-WRITE | ------------------------------------------------------------------------------------------------- pre-update | | | lock item | ------------------------------------------------------------------------------------------------- on-update | throws exception | | | ------------------------------------------------------------------------------------------------- after-transaction | | update item cache | remove item cache | ------------------------------------------------------------------------------------------------- ``` #### DELETE : ``` ************************************************************************************************* UnitOfWork#commit Connection#beginTransaction CachedPersister#delete -> Region#lock -> execute Connection#commit CachedPersister#afterTransactionComplete -> Region#evict ************************************************************************************************* | READ-ONLY | NONSTRICT-READ-WRITE | READ-WRITE | ------------------------------------------------------------------------------------------------- pre-remove | | | | ------------------------------------------------------------------------------------------------- on-remove | | | lock item | ------------------------------------------------------------------------------------------------- after-transaction | remove item cache | remove item cache | remove item cache | ------------------------------------------------------------------------------------------------- ``` #### USAGE : ``` php <?php /** * @Entity * @Cache("NONSTRICT_READ_WRITE") */ class State { /** * @Id * @GeneratedValue * @Column(type="integer") */ protected $id; /** * @Column */ protected $name; /** * @Cache() * @ManyToOne(targetEntity="Country") * @JoinColumn(name="country_id", referencedColumnName="id") */ protected $country; /** * @Cache() * @OneToMany(targetEntity="City", mappedBy="state") */ protected $cities; } ``` ``` php <?php $em->persist(new State($name, $country)); $em->flush(); // Put into cache $em->clear(); // Clear entity manager $state = $em->find('Entity\State', 1); // Retreive item from cache $country = $state->getCountry(); // Retreive item from cache $cities = $state->getCities(); // Load from database and put into cache $state->setName("New Name"); $em->persist($state); $em->flush(); // Update item cache $em->clear(); // Clear entity manager $em->find('Entity\State', 1)->getCities(); // Retreive from cache $em->getCache()->containsEntity('Entity\State', $state->getId()) // Check if the cache exists $em->getCache()->evictEntity('Entity\State', $state->getId()); // Remove an entity from cache $em->getCache()->evictEntityRegion('Entity\State'); // Remove all entities from cache $em->getCache()->containsCollection('Entity\State', 'cities', $state->getId()); // Check if the cache exists $em->getCache()->evictCollection('Entity\State', 'cities', $state->getId()); // Remove an entity collection from cache $em->getCache()->evictCollectionRegion('Entity\State', 'cities'); // Remove all collections from cache ``` #### TODO : - [x] Handle many to many collection - [x] Handle inheritance - [x] Remove/add colection items on update - [x] Improve region tests - [x] Improve cached persisters coverage - [x] Implement xml / yml / php drivers - [x] Implement transaction region _(Improve cache drivers)_ - [x] Implement query cache _**(need more tests)**_ - [x] Read and write region when using query cache - [x] Update documentation - [x] Implement cache cache hits and misses log - [ ] .... ????

admin added the pull-request label 2026-01-22 15:59:46 +01:00

admin closed this issue

2026-01-22 15:59:46 +01:00

admin referenced this issue

2026-01-22 16:09:15 +01:00

[PR #8403] Fixed embeddable loading #10967

Sign in to join this conversation.