Skip to content

Commit bf7e34d

Browse files
Document expiration constraint on UpdateTimestampsCache region.
1 parent 293c2eb commit bf7e34d

File tree

1 file changed

+14
-5
lines changed

1 file changed

+14
-5
lines changed

doc/reference/modules/performance.xml

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -943,11 +943,20 @@ sessionFactory.EvictCollection("Eg.Cat.Kittens");]]></programlisting>
943943
<para>
944944
This setting causes the creation of two new cache regions - one holding cached query
945945
result sets (<literal>NHibernate.Cache.StandardQueryCache</literal>), the other
946-
holding timestamps of the most recent updates to queryable tables
947-
(<literal>NHibernate.Cache.UpdateTimestampsCache</literal>). Note that the query
948-
cache does not cache the state of any entities in the result set; it caches
949-
only identifier values and results of value type. So the query cache should always be
950-
used in conjunction with the second-level cache.
946+
holding timestamps of the most recent updates to queryable tables
947+
(<literal>UpdateTimestampsCache</literal>). Those region names will be prefixed by the
948+
cache region prefix if <literal>cache.region_prefix</literal> setting is configured.
949+
</para>
950+
<para>
951+
If you use a cache provider handling an expiration for cached entries, you should set
952+
the <literal>UpdateTimestampsCache</literal> region expiration to a value greater than
953+
the expiration of query cache regions. (Or disable its expiration.) Otherwise the query
954+
cache may yield stale data.
955+
</para>
956+
<para>
957+
Note that the query cache does not cache the state of any entities in the result set;
958+
it caches only identifier values and results of value type. So the query cache should
959+
always be used in conjunction with the second-level cache.
951960
</para>
952961

953962
<para>

0 commit comments

Comments
 (0)