程序包 org.hibernate.engine.query.spi

类 QueryPlanCache

java.lang.Object

org.hibernate.engine.query.spi.QueryPlanCache

所有已实现的接口:

Serializable

public class QueryPlanCache
extends Object
implements Serializable

Acts as a cache for compiled query plans, as well as query-parameter metadata.

作者:

Steve Ebersole

另请参阅:

AvailableSettings.QUERY_PLAN_CACHE_PARAMETER_METADATA_MAX_SIZE, AvailableSettings.QUERY_PLAN_CACHE_MAX_SIZE, 序列化表格

字段概要

字段

修饰符和类型	字段	说明
static int	DEFAULT_PARAMETER_METADATA_MAX_COUNT	The default strong reference count.
static int	DEFAULT_QUERY_PLAN_MAX_COUNT	The default soft reference count.

构造器概要

构造器

构造器	说明
QueryPlanCache(SessionFactoryImplementor factory)	Constructs the QueryPlanCache to be used by the given SessionFactory

方法概要

修饰符和类型	方法	说明
void	cleanup()	Clean up the caches when the SessionFactory is closed.
FilterQueryPlan	getFilterQueryPlan(String filterString, String collectionRole, boolean shallow, Map<String,Filter> enabledFilters)	Get the query plan for the given collection HQL filter fragment, creating it and caching it if not already cached
HQLQueryPlan	getHQLQueryPlan(String queryString, boolean shallow, Map<String,Filter> enabledFilters)	Get the query plan for the given HQL query, creating it and caching it if not already cached
NativeQueryInterpreter	getNativeQueryInterpreter()
NativeSQLQueryPlan	getNativeSQLQueryPlan(NativeSQLQuerySpecification spec)	Get the query plan for a native SQL query, creating it and caching it if not already cached
ParameterMetadata	getSQLParameterMetadata(String query, boolean isOrdinalParameterZeroBased)	Obtain the parameter metadata for given native-sql query.

从类继承的方法 java.lang.Object

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

字段详细资料

DEFAULT_PARAMETER_METADATA_MAX_COUNT

public static final int DEFAULT_PARAMETER_METADATA_MAX_COUNT

The default strong reference count.

另请参阅:

常量字段值

DEFAULT_QUERY_PLAN_MAX_COUNT

public static final int DEFAULT_QUERY_PLAN_MAX_COUNT

The default soft reference count.

另请参阅:

常量字段值

构造器详细资料

QueryPlanCache

public QueryPlanCache(SessionFactoryImplementor factory)

Constructs the QueryPlanCache to be used by the given SessionFactory

参数:

factory - The SessionFactory

方法详细资料

getSQLParameterMetadata

public ParameterMetadata getSQLParameterMetadata(String query,
                                                 boolean isOrdinalParameterZeroBased)

Obtain the parameter metadata for given native-sql query.

for native-sql queries, the param metadata is determined outside any relation to a query plan, because query plan creation and/or retrieval for a native-sql query depends on all of the return types having been set, which might not be the case up-front when param metadata would be most useful

参数:

query - The query

返回:

The parameter metadata

getHQLQueryPlan

public HQLQueryPlan getHQLQueryPlan(String queryString,
                                    boolean shallow,
                                    Map<String,Filter> enabledFilters)
                             throws QueryException,
                                    MappingException

Get the query plan for the given HQL query, creating it and caching it if not already cached

参数:

queryString - The HQL query string

shallow - Whether the execution will be shallow

enabledFilters - The filters enabled on the Session

返回:

The query plan

抛出:

QueryException - Indicates a problem translating the query

MappingException - Indicates a problem translating the query

getFilterQueryPlan

public FilterQueryPlan getFilterQueryPlan(String filterString,
                                          String collectionRole,
                                          boolean shallow,
                                          Map<String,Filter> enabledFilters)
                                   throws QueryException,
                                          MappingException

Get the query plan for the given collection HQL filter fragment, creating it and caching it if not already cached

参数:

filterString - The HQL filter fragment

collectionRole - The collection being filtered

shallow - Whether the execution will be shallow

enabledFilters - The filters enabled on the Session

返回:

The query plan

抛出:

QueryException - Indicates a problem translating the query

MappingException - Indicates a problem translating the query

getNativeSQLQueryPlan

public NativeSQLQueryPlan getNativeSQLQueryPlan(NativeSQLQuerySpecification spec)

Get the query plan for a native SQL query, creating it and caching it if not already cached

参数:

spec - The native SQL query specification

返回:

The query plan

抛出:

QueryException - Indicates a problem translating the query

MappingException - Indicates a problem translating the query

cleanup

public void cleanup()

Clean up the caches when the SessionFactory is closed.

Note that depending on the cache strategy implementation chosen, clearing the cache might not reclaim all the memory.

Typically, when using LIRS, clearing the cache only invalidates the entries but the outdated entries are kept in memory until they are replaced by others. It is not considered a memory leak as the cache is bounded.

getNativeQueryInterpreter

public NativeQueryInterpreter getNativeQueryInterpreter()