Class MutationQueryOptions
- java.lang.Object
-
- org.hibernate.engine.jdbc.mutation.internal.MutationQueryOptions
-
- All Implemented Interfaces:
QueryOptions
public class MutationQueryOptions extends Object implements QueryOptions
-
-
Field Summary
Fields Modifier and Type Field Description static MutationQueryOptions
INSTANCE
-
Fields inherited from interface org.hibernate.query.spi.QueryOptions
NONE, READ_ONLY, READ_WRITE
-
-
Constructor Summary
Constructors Constructor Description MutationQueryOptions()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AppliedGraph
getAppliedGraph()
JPAEntityGraph
explicitly applied to the query.CacheRetrieveMode
getCacheRetrieveMode()
Controls whether query results are read from the cache.CacheStoreMode
getCacheStoreMode()
Controls whether query results are put into the cache.String
getComment()
The SQL comment to apply to the interpreted SQL query, for dialects which support SQL commentsList<String>
getDatabaseHints()
Hints to apply to the interpreted SQL queryInteger
getFetchSize()
The fetch size to be applied to the JDBC query.FlushMode
getFlushMode()
The flush mode to use for the query executionLimit
getLimit()
The limit to the query results.LockOptions
getLockOptions()
Describes the locking to apply to the query resultsString
getResultCacheRegionName()
The query cache region in which the results should be cached.ResultListTransformer<?>
getResultListTransformer()
Transformer applied to the query to transform the structure of the overall resultsInteger
getTimeout()
The timeout to apply to the query.TupleTransformer<?>
getTupleTransformer()
Transformer applied to the query to transform the structure of each "row" in the resultsBoolean
isReadOnly()
Should entities returned from the query be marked read-only.Boolean
isResultCachingEnabled()
Should results from the query be cached?-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.hibernate.query.spi.QueryOptions
getCacheMode, getEffectiveLimit, getFirstRow, getMaxRows, getUniqueSemantic, hasLimit
-
-
-
-
Field Detail
-
INSTANCE
public static final MutationQueryOptions INSTANCE
-
-
Method Detail
-
getTimeout
public Integer getTimeout()
Description copied from interface:QueryOptions
The timeout to apply to the query. May also be defined at the transaction level usingTransaction.getTimeout()
- Specified by:
getTimeout
in interfaceQueryOptions
-
getFlushMode
public FlushMode getFlushMode()
Description copied from interface:QueryOptions
The flush mode to use for the query execution- Specified by:
getFlushMode
in interfaceQueryOptions
-
isReadOnly
public Boolean isReadOnly()
Description copied from interface:QueryOptions
Should entities returned from the query be marked read-only.- Specified by:
isReadOnly
in interfaceQueryOptions
-
getAppliedGraph
public AppliedGraph getAppliedGraph()
Description copied from interface:QueryOptions
JPAEntityGraph
explicitly applied to the query.- Specified by:
getAppliedGraph
in interfaceQueryOptions
-
getTupleTransformer
public TupleTransformer<?> getTupleTransformer()
Description copied from interface:QueryOptions
Transformer applied to the query to transform the structure of each "row" in the results- Specified by:
getTupleTransformer
in interfaceQueryOptions
-
getResultListTransformer
public ResultListTransformer<?> getResultListTransformer()
Description copied from interface:QueryOptions
Transformer applied to the query to transform the structure of the overall results- Specified by:
getResultListTransformer
in interfaceQueryOptions
-
isResultCachingEnabled
public Boolean isResultCachingEnabled()
Description copied from interface:QueryOptions
Should results from the query be cached?- Specified by:
isResultCachingEnabled
in interfaceQueryOptions
- See Also:
QueryOptions.getCacheMode()
,QueryOptions.getResultCacheRegionName()
-
getCacheRetrieveMode
public CacheRetrieveMode getCacheRetrieveMode()
Description copied from interface:QueryOptions
Controls whether query results are read from the cache. No effect unlessQueryOptions.isResultCachingEnabled()
returnstrue
- Specified by:
getCacheRetrieveMode
in interfaceQueryOptions
- See Also:
CacheMode
-
getCacheStoreMode
public CacheStoreMode getCacheStoreMode()
Description copied from interface:QueryOptions
Controls whether query results are put into the cache. No effect unlessQueryOptions.isResultCachingEnabled()
returnstrue
- Specified by:
getCacheStoreMode
in interfaceQueryOptions
- See Also:
CacheMode
-
getResultCacheRegionName
public String getResultCacheRegionName()
Description copied from interface:QueryOptions
The query cache region in which the results should be cached. No effect unlessQueryOptions.isResultCachingEnabled()
returnstrue
- Specified by:
getResultCacheRegionName
in interfaceQueryOptions
-
getLockOptions
public LockOptions getLockOptions()
Description copied from interface:QueryOptions
Describes the locking to apply to the query results- Specified by:
getLockOptions
in interfaceQueryOptions
-
getComment
public String getComment()
Description copied from interface:QueryOptions
The SQL comment to apply to the interpreted SQL query, for dialects which support SQL comments- Specified by:
getComment
in interfaceQueryOptions
-
getDatabaseHints
public List<String> getDatabaseHints()
Description copied from interface:QueryOptions
Hints to apply to the interpreted SQL query- Specified by:
getDatabaseHints
in interfaceQueryOptions
-
getFetchSize
public Integer getFetchSize()
Description copied from interface:QueryOptions
The fetch size to be applied to the JDBC query.- Specified by:
getFetchSize
in interfaceQueryOptions
- See Also:
Statement.getFetchSize()
-
getLimit
public Limit getLimit()
Description copied from interface:QueryOptions
The limit to the query results. May also be accessed viaQueryOptions.getFirstRow()
andQueryOptions.getMaxRows()
- Specified by:
getLimit
in interfaceQueryOptions
-
-