Doctrine\DBAL\Statement can automatically cache result sets. The
feature is optional though, and by default, no result set is cached.
To use the result cache, there are three mandatory steps:
- Configure a global result cache, or provide one at query time.
- Provide a cache profile for the result set you want to cache when making a query.
- Read the entire result set from the database.
Any instance of
Doctrine\Common\Cache\Cache can be used as a result
cache and can be set on the configuration object (optionally it can also
be passed at query time):
To get the result set of a query cached, it is necessary to pass a
Doctrine\DBAL\Cache\QueryCacheProfile instance to the
executeCacheQuery() methods. The difference
between these two methods is that the former has the cache profile as an
optional argument, whereas it is required when calling the latter:
As stated before, it is also possible to pass in a
Doctrine\Common\Cache\Cache instance into the constructor of
Doctrine\DBAL\Cache\QueryCacheProfile in which case it overrides the
default cache instance:
Caching half a result set would cause bugs if a subsequent caller needed
more rows from that same result sets. To be able to cache the entire
result set, it must be fetched entirely from the database, and not all
APIs do that. The easiest way to ensure that is to use one of the
When using the cache layer not all fetch modes are supported. See
the code of the