Package org.hibernate.cache.spi

Interface QueryResultsCache

public interface QueryResultsCache

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()
List<?>	get(QueryKey key, String[] spaces, SharedSessionContractImplementor session)	Get results from the cache.
List<?>	get(QueryKey key, Set<String> spaces, SharedSessionContractImplementor session)	Get results from the cache.
QueryResultsRegion	getRegion()	The underlying cache region being used.
boolean	put(QueryKey key, List<?> result, SharedSessionContractImplementor session)	Put a result into the query cache.

Method Detail

getRegion

QueryResultsRegion getRegion()

The underlying cache region being used.

put

boolean put(QueryKey key,
            List<?> result,
            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<String> spaces,
            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,
            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.

clear

default void clear()
            throws CacheException

Clear items from the query cache.

Throws:

CacheException - Indicates a problem delegating to the underlying cache.

destroy

default void destroy()