org.gridgain.grid.cache.hibernate

Class GridHibernateQueryResultsRegion

java.lang.Object

org.gridgain.grid.cache.hibernate.GridHibernateRegion

org.gridgain.grid.cache.hibernate.GridHibernateGeneralDataRegion

org.gridgain.grid.cache.hibernate.GridHibernateQueryResultsRegion

All Implemented Interfaces:

org.hibernate.cache.spi.GeneralDataRegion, org.hibernate.cache.spi.QueryResultsRegion, org.hibernate.cache.spi.Region

public class GridHibernateQueryResultsRegion
extends GridHibernateGeneralDataRegion
implements org.hibernate.cache.spi.QueryResultsRegion

Implementation of QueryResultsRegion. This region is used to store query results.

Query results caching can be enabled in the Hibernate configuration file:

 <hibernate-configuration>
     <!-- Enable L2 cache. -->
     <property name="cache.use_second_level_cache">true</property>

     <!-- Enable query cache. -->
     <property name="cache.use_second_level_cache">true</property>

     <!-- Use GridGain as L2 cache provider. -->
     <property name="cache.region.factory_class">org.gridgain.grid.cache.hibernate.GridHibernateRegionFactory</property>

     <!-- Specify entity. -->
     <mapping class="com.example.Entity"/>

     <!-- Enable L2 cache with nonstrict-read-write access strategy for entity. -->
     <class-cache class="com.example.Entity" usage="nonstrict-read-write"/>
 </hibernate-configuration>
 

By default queries are not cached even after enabling query caching, to enable results caching for a particular query, call Query.setCacheable(boolean):

     Session ses = getSession();

     Query qry = ses.createQuery("...");

     qry.setCacheable(true); // Enable L2 cache for query.
 

Note: the query cache does not cache the state of the actual entities in the cache, it caches only identifier values. For this reason, the query cache should always be used in conjunction with the second-level cache for those entities expected to be cached as part of a query result cache

Field Summary

Fields inherited from class org.gridgain.grid.cache.hibernate.GridHibernateRegion

cache, factory, grid

Constructor Summary

Constructors

Constructor and Description
GridHibernateQueryResultsRegion(GridHibernateRegionFactory factory, String name, org.gridgain.grid.Grid grid, org.gridgain.grid.cache.GridCache<Object,Object> cache)

Method Summary

Methods inherited from class org.gridgain.grid.cache.hibernate.GridHibernateGeneralDataRegion

evict, evictAll, get, put

Methods inherited from class org.gridgain.grid.cache.hibernate.GridHibernateRegion

contains, destroy, getElementCountInMemory, getElementCountOnDisk, getName, getSizeInMemory, getTimeout, nextTimestamp, toMap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hibernate.cache.spi.GeneralDataRegion

evict, evictAll, get, put

Methods inherited from interface org.hibernate.cache.spi.Region

contains, destroy, getElementCountInMemory, getElementCountOnDisk, getName, getSizeInMemory, getTimeout, nextTimestamp, toMap

Constructor Detail

GridHibernateQueryResultsRegion

public GridHibernateQueryResultsRegion(GridHibernateRegionFactory factory,
                               String name,
                               org.gridgain.grid.Grid grid,
                               org.gridgain.grid.cache.GridCache<Object,Object> cache)

Parameters:

factory - Region factory.

name - Region name.

grid - Grid.

cache - Region cache.