Package org.hibernate.cache.spi

Interface QueryResultsCache

All Superinterfaces:

QueryCache

public interface QueryResultsCache
extends QueryCache

Defines the responsibility for managing query result data caching in regards to a specific region.

Method Summary

Modifier and Type	Method	Description
default void	clear()	Clear items from the query cache.
default void	destroy()	Destroy the cache.
List	get(QueryKey key, String[] spaces, Type[] returnTypes, SharedSessionContractImplementor session)	Get results from the cache.
List	get(QueryKey key, Set<Serializable> spaces, Type[] returnTypes, SharedSessionContractImplementor session)	Get results from the cache.
default List	get(QueryKey key, Type[] returnTypes, boolean isNaturalKeyLookup, Set<Serializable> spaces, SharedSessionContractImplementor session)	Get results from the cache.
QueryResultsRegion	getRegion()	The underlying cache region being used.
boolean	put(QueryKey key, List result, Type[] returnTypes, SharedSessionContractImplementor session)	Put a result into the query cache.
default boolean	put(QueryKey key, Type[] returnTypes, List result, boolean isNaturalKeyLookup, SharedSessionContractImplementor session)	Put a result into the query cache.

Method Detail

getRegion

QueryResultsRegion getRegion()

The underlying cache region being used.

Specified by:

getRegion in interface QueryCache

Returns:

The cache region.

clear

default void clear()
            throws CacheException

Clear items from the query cache.

Specified by:

clear in interface QueryCache

Throws:

CacheException - Indicates a problem delegating to the underlying cache.

put

boolean put(QueryKey key,
            List result,
            Type[] returnTypes,
            SharedSessionContractImplementor session)
     throws HibernateException

Put a result into the query cache.

Parameters:

key - The cache key

result - The results to cache

session - The originating session

Returns:

Whether the put actually happened.

Throws:

HibernateException - Indicates a problem delegating to the underlying cache.

get

List get(QueryKey key,
         Set<Serializable> spaces,
         Type[] returnTypes,
         SharedSessionContractImplementor session)
  throws HibernateException

Get results from the cache.

Parameters:

key - The cache key

spaces - The query spaces (used in invalidation plus validation checks)

session - The originating session

Returns:

The cached results; may be null.

Throws:

HibernateException - Indicates a problem delegating to the underlying cache.

get

List get(QueryKey key,
         String[] spaces,
         Type[] returnTypes,
         SharedSessionContractImplementor session)
  throws HibernateException

Get results from the cache.

Parameters:

key - The cache key

spaces - The query spaces (used in invalidation plus validation checks)

session - The originating session

Returns:

The cached results; may be null.

Throws:

HibernateException - Indicates a problem delegating to the underlying cache.

put

default boolean put(QueryKey key,
                    Type[] returnTypes,
                    List result,
                    boolean isNaturalKeyLookup,
                    SharedSessionContractImplementor session)

Description copied from interface: QueryCache

Put a result into the query cache.

Specified by:

put in interface QueryCache

Parameters:

key - The cache key

returnTypes - The result types

result - The results to cache

isNaturalKeyLookup - Was this a natural id lookup?

session - The originating session

Returns:

Whether the put actually happened.

get

default List get(QueryKey key,
                 Type[] returnTypes,
                 boolean isNaturalKeyLookup,
                 Set<Serializable> spaces,
                 SharedSessionContractImplementor session)

Description copied from interface: QueryCache

Get results from the cache.

Specified by:

get in interface QueryCache

Parameters:

key - The cache key

returnTypes - The result types

isNaturalKeyLookup - Was this a natural id lookup?

spaces - The query spaces (used in invalidation plus validation checks)

session - The originating session

Returns:

The cached results; may be null.

destroy

default void destroy()

Description copied from interface: QueryCache

Destroy the cache.

Specified by:

destroy in interface QueryCache