CommonQueryContract
instead.@Deprecated public interface BasicQueryContract<T extends BasicQueryContract>
Defines the aspects of query definition that apply to all forms of querying.
Modifier and Type | Method and Description |
---|---|
CacheMode |
getCacheMode()
Deprecated.
Obtain the CacheMode in effect for this query.
|
String |
getCacheRegion()
Deprecated.
Obtain the name of the second level query cache region in which query results will be stored (if they are
cached, see the discussion on
isCacheable() for more information). |
Integer |
getFetchSize()
Deprecated.
Obtain the JDBC fetch size hint in effect for this query.
|
FlushMode |
getHibernateFlushMode()
Deprecated.
Obtain the FlushMode in effect for this query.
|
Type[] |
getReturnTypes()
Deprecated.
(since 5.2) with no replacement; to be removed in 6.0
|
Integer |
getTimeout()
Deprecated.
Obtain the query timeout <b>in seconds</b>.
|
boolean |
isCacheable()
Deprecated.
Are the results of this query eligible for second level query caching? This is different that second level
caching of any returned entities and collections.
|
boolean |
isReadOnly()
Deprecated.
Should entities and proxies loaded by this Query be put in read-only mode? If the
read-only/modifiable setting was not initialized, then the default
read-only/modifiable setting for the persistence context is returned instead.
|
T |
setCacheable(boolean cacheable)
Deprecated.
Enable/disable second level query (result) caching for this query.
|
T |
setCacheMode(CacheMode cacheMode)
Deprecated.
(Re)set the current CacheMode in effect for this query.
|
T |
setCacheRegion(String cacheRegion)
Deprecated.
Set the name of the cache region where query results should be cached (if cached at all).
|
T |
setFetchSize(int fetchSize)
Deprecated.
Sets a JDBC fetch size hint for the query.
|
default BasicQueryContract |
setFlushMode(FlushMode flushMode)
Deprecated.
(since 5.2) use
setHibernateFlushMode(org.hibernate.FlushMode) instead |
T |
setHibernateFlushMode(FlushMode flushMode)
Deprecated.
(Re)set the current FlushMode in effect for this query.
|
T |
setReadOnly(boolean readOnly)
Deprecated.
Set the read-only/modifiable mode for entities and proxies
loaded by this Query.
|
T |
setTimeout(int timeout)
Deprecated.
Set the query timeout <b>in seconds</b>.
|
@Deprecated default BasicQueryContract setFlushMode(FlushMode flushMode)
setHibernateFlushMode(org.hibernate.FlushMode)
instead(Re)set the current FlushMode in effect for this query.
flushMode
- The new FlushMode to use.this
, for method chaininggetHibernateFlushMode()
FlushMode getHibernateFlushMode()
Obtain the FlushMode in effect for this query. By default, the query inherits the FlushMode of the Session from which it originates.
Session.getFlushMode()
,
FlushMode
T setHibernateFlushMode(FlushMode flushMode)
(Re)set the current FlushMode in effect for this query.
flushMode
- The new FlushMode to use.this
, for method chaininggetHibernateFlushMode()
CacheMode getCacheMode()
Obtain the CacheMode in effect for this query. By default, the query inherits the CacheMode of the Session from which is originates.
Note
|
The CacheMode here only effects reading/writing of the query cache, not the entity/collection caches. |
Session.getCacheMode()
,
CacheMode
T setCacheMode(CacheMode cacheMode)
(Re)set the current CacheMode in effect for this query.
cacheMode
- The new CacheMode to use.this
, for method chaininggetCacheMode()
boolean isCacheable()
Are the results of this query eligible for second level query caching? This is different that second level caching of any returned entities and collections.
Note
|
the query being "eligible" for caching does not necessarily mean its results will be cached. Second level
query caching still has to be enabled on the SessionFactory for this to happen. Usually that is
controlled by the hibernate.cache.use_query_cache configuration setting.
|
true
if the query results are eligible for caching, false
otherwise.AvailableSettings.USE_QUERY_CACHE
T setCacheable(boolean cacheable)
Enable/disable second level query (result) caching for this query.
cacheable
- Should the query results be cacheable?this
, for method chainingisCacheable()
String getCacheRegion()
Obtain the name of the second level query cache region in which query results will be stored (if they are
cached, see the discussion on isCacheable()
for more information). null
indicates that the
default region should be used.
null
indicates
the default region.T setCacheRegion(String cacheRegion)
Set the name of the cache region where query results should be cached (if cached at all).
cacheRegion
- the name of a query cache region, or null
to indicate that the default region
should be used.this
, for method chaininggetCacheRegion()
Integer getTimeout()
Obtain the query timeout <b>in seconds</b>. This value is eventually passed along to the JDBC query via
Statement.setQueryTimeout(int)
. Zero indicates no timeout.
Statement.getQueryTimeout()
,
Statement.setQueryTimeout(int)
T setTimeout(int timeout)
Set the query timeout <b>in seconds</b>.
NOTE it is important to understand that any value set here is eventually passed directly through to the JDBC Statement which expressly disallows negative values. So negative values should be avoided as a general rule.
timeout
- the timeout <b>in seconds</b>this
, for method chaininggetTimeout()
Integer getFetchSize()
Obtain the JDBC fetch size hint in effect for this query. This value is eventually passed along to the JDBC
query via Statement.setFetchSize(int)
. As defined b y JDBC, this value is a hint to the
driver to indicate how many rows to fetch from the database when more rows are needed.
NOTE : JDBC expressly defines this value as a hint. It may or may not have any effect on the actual query execution and ResultSet processing depending on the driver.
Statement.getFetchSize()
,
Statement.setFetchSize(int)
T setFetchSize(int fetchSize)
Sets a JDBC fetch size hint for the query.
fetchSize
- the fetch size hintthis
, for method chaininggetFetchSize()
boolean isReadOnly()
Should entities and proxies loaded by this Query be put in read-only mode? If the read-only/modifiable setting was not initialized, then the default read-only/modifiable setting for the persistence context is returned instead.
true
if the entities and proxies loaded by the query will be put
in read-only mode; false
otherwise (they will be modifiable)setReadOnly(boolean)
,
PersistenceContext.isDefaultReadOnly()
T setReadOnly(boolean readOnly)
Set the read-only/modifiable mode for entities and proxies loaded by this Query. This setting overrides the default setting for the persistence context.
readOnly
- true
indicates that entities and proxies loaded by the query
are to be put in read-only mode; false
indicates that entities and proxies
loaded by the query will be put in modifiable modethis
, for method chainingPersistenceContext.isDefaultReadOnly()
,
PersistenceContext.setDefaultReadOnly(boolean)
,
Session.setDefaultReadOnly(boolean)
@Deprecated Type[] getReturnTypes()
Return the Hibernate types of the query results.
Copyright © 2001-2018 Red Hat, Inc. All Rights Reserved.