NativeQuery instead.@Deprecated public interface SQLQuery<T> extends Query<T>, SynchronizeableQuery<T>
addSynchronizedQuerySpace(java.lang.String), addSynchronizedEntityName(java.lang.String) and
addSynchronizedEntityClass(java.lang.Class). This allows Hibernate to know how to properly deal with
auto-flush checking as well as cached query results if the results of the query are being
cached.
setResultSetMapping(java.lang.String)
addEntity(java.lang.String), addRoot(java.lang.String, java.lang.String), addJoin(java.lang.String, java.lang.String),
addFetch(java.lang.String, java.lang.String, java.lang.String) and addScalar(java.lang.String) methods
| Modifier and Type | Interface and Description |
|---|---|
static interface |
SQLQuery.FetchReturn
Deprecated.
Allows access to further control how join fetch returns are mapped back from result sets.
|
static interface |
SQLQuery.ReturnProperty
Deprecated.
Allows access to further control how properties within a root or join fetch are mapped back from the result set.
|
static interface |
SQLQuery.RootReturn
Deprecated.
Allows access to further control how root returns are mapped back from result sets.
|
| Modifier and Type | Method and Description |
|---|---|
SQLQuery<T> |
addEntity(Class entityType)
Deprecated.
Declare a "root" entity, without specifying an alias.
|
SQLQuery<T> |
addEntity(String entityName)
Deprecated.
Declare a "root" entity, without specifying an alias.
|
SQLQuery<T> |
addEntity(String tableAlias,
Class entityType)
Deprecated.
Declare a "root" entity.
|
SQLQuery<T> |
addEntity(String tableAlias,
Class entityClass,
LockMode lockMode)
Deprecated.
Declare a "root" entity, specifying a lock mode.
|
SQLQuery<T> |
addEntity(String tableAlias,
String entityName)
Deprecated.
Declare a "root" entity.
|
SQLQuery<T> |
addEntity(String tableAlias,
String entityName,
LockMode lockMode)
Deprecated.
Declare a "root" entity, specifying a lock mode.
|
SQLQuery.FetchReturn |
addFetch(String tableAlias,
String ownerTableAlias,
String joinPropertyName)
Deprecated.
Declare a join fetch result.
|
SQLQuery<T> |
addJoin(String tableAlias,
String path)
Deprecated.
Declare a join fetch result.
|
SQLQuery<T> |
addJoin(String tableAlias,
String path,
LockMode lockMode)
Deprecated.
Declare a join fetch result, specifying a lock mode.
|
SQLQuery<T> |
addJoin(String tableAlias,
String ownerTableAlias,
String joinPropertyName)
Deprecated.
Declare a join fetch result.
|
NativeQuery<T> |
addQueryHint(String hint)
Deprecated.
Add a DB query hint to the SQL.
|
SQLQuery.RootReturn |
addRoot(String tableAlias,
Class entityType)
Deprecated.
Add a new root return mapping, returning a
NativeQuery.RootReturn to allow further definition. |
SQLQuery.RootReturn |
addRoot(String tableAlias,
String entityName)
Deprecated.
Add a new root return mapping, returning a
NativeQuery.RootReturn to allow further definition. |
SQLQuery<T> |
addScalar(String columnAlias)
Deprecated.
Declare a scalar query result.
|
SQLQuery<T> |
addScalar(String columnAlias,
Type type)
Deprecated.
Declare a scalar query result.
|
SQLQuery<T> |
addSynchronizedEntityClass(Class entityClass)
Deprecated.
Adds an entity for (a) auto-flush checking and (b) query result cache invalidation checking.
|
SQLQuery<T> |
addSynchronizedEntityName(String entityName)
Deprecated.
Adds an entity name for (a) auto-flush checking and (b) query result cache invalidation checking.
|
SQLQuery<T> |
addSynchronizedQuerySpace(String querySpace)
Deprecated.
Adds a query space.
|
List<NativeSQLQueryReturn> |
getQueryReturns()
Deprecated.
Retrieve the returns associated with this query.
|
boolean |
isCallable()
Deprecated.
Is this native-SQL query known to be callable?
|
NativeQuery<T> |
setCacheable(boolean cacheable)
Deprecated.
Enable/disable second level query (result) caching for this query.
|
NativeQuery<T> |
setCacheMode(CacheMode cacheMode)
Deprecated.
(Re)set the current CacheMode in effect for this query.
|
NativeQuery<T> |
setCacheRegion(String cacheRegion)
Deprecated.
Set the name of the cache region where query results should be cached (if cached at all).
|
NativeQuery<T> |
setComment(String comment)
Deprecated.
Set the comment for this query.
|
NativeQuery<T> |
setFetchSize(int fetchSize)
Deprecated.
Sets a JDBC fetch size hint for the query.
|
NativeQuery<T> |
setFlushMode(FlushMode flushMode)
Deprecated.
(Re)set the current FlushMode in effect for this query.
|
NativeQuery<T> |
setFlushMode(FlushModeType flushMode)
Deprecated.
Set the flush mode type to be used for the query execution.
|
NativeQuery<T> |
setHibernateFlushMode(FlushMode flushMode)
Deprecated.
(Re)set the current FlushMode in effect for this query.
|
NativeQuery<T> |
setLockMode(String alias,
LockMode lockMode)
Deprecated.
Set the LockMode to use for specific alias (as defined in the query's FROM clause).
|
NativeQuery<T> |
setLockOptions(LockOptions lockOptions)
Deprecated.
Set the lock options for the query.
|
NativeQuery<T> |
setParameter(int position,
Calendar value,
TemporalType temporalType)
Deprecated.
Bind an instance of
java.util.Calendar to a positional
parameter. |
NativeQuery<T> |
setParameter(int position,
Date value,
TemporalType temporalType)
Deprecated.
Bind an instance of
java.util.Date to a positional parameter. |
NativeQuery<T> |
setParameter(int position,
Object val)
Deprecated.
Bind a positional query parameter using its inferred Type.
|
NativeQuery<T> |
setParameter(int position,
Object val,
Type type)
Deprecated.
Bind a value to a JDBC-style query parameter.
|
<P> NativeQuery<T> |
setParameter(int position,
P val,
TemporalType temporalType)
Deprecated.
Bind a positional query parameter as some form of date/time using
the indicated temporal-type.
|
NativeQuery<T> |
setParameter(Parameter<Calendar> param,
Calendar value,
TemporalType temporalType)
Deprecated.
Bind an instance of
java.util.Calendar to a Parameter object. |
NativeQuery<T> |
setParameter(Parameter<Date> param,
Date value,
TemporalType temporalType)
Deprecated.
Bind an instance of
java.util.Date to a Parameter object. |
<P> NativeQuery<T> |
setParameter(Parameter<P> param,
P value)
Deprecated.
Bind the value of a
Parameter object. |
<P> NativeQuery<T> |
setParameter(QueryParameter<P> parameter,
P val)
Deprecated.
Bind a query parameter using its inferred Type.
|
<P> NativeQuery<T> |
setParameter(QueryParameter<P> parameter,
P val,
TemporalType temporalType)
Deprecated.
Bind a query parameter as some form of date/time using the indicated
temporal-type.
|
<P> NativeQuery<T> |
setParameter(QueryParameter<P> parameter,
P val,
Type type)
Deprecated.
Bind a query parameter using the supplied Type
|
NativeQuery<T> |
setParameter(String name,
Calendar value,
TemporalType temporalType)
Deprecated.
Bind an instance of
java.util.Calendar to a named parameter. |
NativeQuery<T> |
setParameter(String name,
Date value,
TemporalType temporalType)
Deprecated.
Bind an instance of
java.util.Date to a named parameter. |
NativeQuery<T> |
setParameter(String name,
Object val)
Deprecated.
Bind a named query parameter using its inferred Type.
|
NativeQuery<T> |
setParameter(String name,
Object val,
Type type)
Deprecated.
Bind a named query parameter using the supplied Type
|
<P> NativeQuery<T> |
setParameter(String name,
P val,
TemporalType temporalType)
Deprecated.
Bind a named query parameter as some form of date/time using
the indicated temporal-type.
|
<P> NativeQuery<T> |
setParameterList(QueryParameter<P> parameter,
Collection<P> values)
Deprecated.
Bind multiple values to a query parameter using its inferred Type.
|
NativeQuery<T> |
setParameterList(String name,
Collection values)
Deprecated.
Bind multiple values to a named query parameter.
|
NativeQuery<T> |
setParameterList(String name,
Collection values,
Type type)
Deprecated.
Bind multiple values to a named query parameter.
|
NativeQuery<T> |
setParameterList(String name,
Object[] values)
Deprecated.
Bind multiple values to a named query parameter.
|
NativeQuery<T> |
setParameterList(String name,
Object[] values,
Type type)
Deprecated.
Bind multiple values to a named query parameter.
|
NativeQuery<T> |
setProperties(Map bean)
Deprecated.
Bind the values of the given Map for each named parameters of the query,
matching key names with parameter names and mapping value types to
Hibernate types using heuristics.
|
NativeQuery<T> |
setProperties(Object bean)
Deprecated.
Bind the property values of the given bean to named parameters of the query,
matching property names with parameter names and mapping property types to
Hibernate types using heuristics.
|
NativeQuery<T> |
setReadOnly(boolean readOnly)
Deprecated.
Set the read-only/modifiable mode for entities and proxies
loaded by this Query.
|
SQLQuery<T> |
setResultSetMapping(String name)
Deprecated.
Use a predefined named result-set mapping.
|
NativeQuery<T> |
setTimeout(int timeout)
Deprecated.
Set the query timeout in seconds.
|
determineProperBooleanType, determineProperBooleanType, getCacheMode, getCacheRegion, getComment, getFetchSize, getFlushMode, getHibernateFirstResult, getHibernateFlushMode, getHibernateMaxResults, getLockOptions, getNamedParameters, getParameterMetadata, getQueryOptions, getQueryString, getReturnAliases, getReturnTypes, getTimeout, isCacheable, isReadOnly, iterate, list, scroll, scroll, setBigDecimal, setBigDecimal, setBigInteger, setBigInteger, setBinary, setBinary, setBoolean, setBoolean, setByte, setByte, setCalendar, setCalendar, setCalendarDate, setCalendarDate, setCharacter, setCharacter, setDate, setDate, setDouble, setDouble, setEntity, setEntity, setFirstResult, setFloat, setFloat, setHibernateFirstResult, setHibernateMaxResults, setHint, setInteger, setInteger, setLocale, setLocale, setLockMode, setLong, setLong, setMaxResults, setParameterList, setParameterList, setParameterList, setParameterList, setParameters, setResultTransformer, setSerializable, setSerializable, setShort, setShort, setString, setString, setText, setText, setTime, setTime, setTimestamp, setTimestamp, uniqueResultgetResultList, getResultStream, getSingleResultexecuteUpdate, getFirstResult, getHints, getLockMode, getMaxResults, getParameter, getParameter, getParameter, getParameter, getParameters, getParameterValue, getParameterValue, getParameterValue, isBound, unwrapgetSynchronizedQuerySpacesSQLQuery<T> setResultSetMapping(String name)
<result-set/> element in a
Hibernate hbm.xml file or through a SqlResultSetMapping annotation.name - The name of the mapping to use.boolean isCallable()
true if the query is known to be callable; false otherwise.List<NativeSQLQueryReturn> getQueryReturns()
SQLQuery<T> addScalar(String columnAlias)
<return-scalar/> in hbm.xml or ColumnResultcolumnAlias - The column alias in the result-set to be processed as a scalar resultthis, for method chainingSQLQuery<T> addScalar(String columnAlias, Type type)
columnAlias - The column alias in the result-set to be processed as a scalar resulttype - The Hibernate type as which to treat the value.this, for method chainingSQLQuery.RootReturn addRoot(String tableAlias, String entityName)
NativeQuery.RootReturn to allow further definition.tableAlias - The SQL table alias to map to this entityentityName - The name of the entity.SQLQuery.RootReturn addRoot(String tableAlias, Class entityType)
NativeQuery.RootReturn to allow further definition.tableAlias - The SQL table alias to map to this entityentityType - The java type of the entity.SQLQuery<T> addEntity(String entityName)
addRoot(java.lang.String, java.lang.String) if you need further control of the mappingentityName - The entity name that is the root return of the query.this, for method chainingSQLQuery<T> addEntity(String tableAlias, String entityName)
tableAlias - The SQL table aliasentityName - The entity namethis, for method chainingSQLQuery<T> addEntity(String tableAlias, String entityName, LockMode lockMode)
tableAlias - The SQL table aliasentityName - The entity namelockMode - The lock mode for this return.this, for method chainingSQLQuery<T> addEntity(Class entityType)
entityType - The java type of the entity to add as a rootthis, for method chainingSQLQuery<T> addEntity(String tableAlias, Class entityType)
tableAlias - The SQL table aliasentityType - The java type of the entity to add as a rootthis, for method chainingSQLQuery<T> addEntity(String tableAlias, Class entityClass, LockMode lockMode)
tableAlias - The SQL table aliasentityClass - The entity ClasslockMode - The lock mode for this return.this, for method chainingSQLQuery.FetchReturn addFetch(String tableAlias, String ownerTableAlias, String joinPropertyName)
tableAlias - The SQL table alias for the data to be mapped to this fetchownerTableAlias - Identify the table alias of the owner of this association. Should match the alias of a
previously added root or fetchjoinPropertyName - The name of the property being join fetched.SQLQuery<T> addJoin(String tableAlias, String path)
tableAlias - The SQL table alias for the data to be mapped to this fetchpath - The association path ([owner-alias].[property-name]).this, for method chainingSQLQuery<T> addJoin(String tableAlias, String ownerTableAlias, String joinPropertyName)
tableAlias - The SQL table alias for the data to be mapped to this fetchownerTableAlias - Identify the table alias of the owner of this association. Should match the alias of a
previously added root or fetchjoinPropertyName - The name of the property being join fetched.this, for method chainingSQLQuery<T> addJoin(String tableAlias, String path, LockMode lockMode)
tableAlias - The SQL table alias for the data to be mapped to this fetchpath - The association path ([owner-alias].[property-name]).lockMode - The lock mode for this return.this, for method chainingSQLQuery<T> addSynchronizedQuerySpace(String querySpace)
SynchronizeableQueryaddSynchronizedQuerySpace in interface SynchronizeableQuery<T>querySpace - The query space to be auto-flushed for this query.this, for method chainingSQLQuery<T> addSynchronizedEntityName(String entityName) throws MappingException
SynchronizeableQuerySynchronizeableQuery.addSynchronizedQuerySpace(java.lang.String) for all tables associated with the given entity.addSynchronizedEntityName in interface SynchronizeableQuery<T>entityName - The name of the entity upon whose defined query spaces we should additionally synchronize.this, for method chainingMappingException - Indicates the given name could not be resolved as an entitySQLQuery<T> addSynchronizedEntityClass(Class entityClass) throws MappingException
SynchronizeableQuerySynchronizeableQuery.addSynchronizedQuerySpace(java.lang.String) for all tables associated with the given entity.addSynchronizedEntityClass in interface SynchronizeableQuery<T>entityClass - The class of the entity upon whose defined query spaces we should additionally synchronize.this, for method chainingMappingException - Indicates the given class could not be resolved as an entityNativeQuery<T> setHibernateFlushMode(FlushMode flushMode)
QuerysetHibernateFlushMode in interface BasicQueryContract<CommonQueryContract>flushMode - The new FlushMode to use.this, for method chainingQuery.getHibernateFlushMode()NativeQuery<T> setFlushMode(FlushModeType flushMode)
TypedQuerysetFlushMode in interface QuerysetFlushMode in interface TypedQuery<T>flushMode - flush modeNativeQuery<T> setCacheMode(CacheMode cacheMode)
QuerysetCacheMode in interface BasicQueryContract<CommonQueryContract>cacheMode - The new CacheMode to use.this, for method chainingQuery.getCacheMode()NativeQuery<T> setCacheable(boolean cacheable)
QuerysetCacheable in interface BasicQueryContract<CommonQueryContract>cacheable - Should the query results be cacheable?this, for method chainingQuery.isCacheable()NativeQuery<T> setCacheRegion(String cacheRegion)
QuerysetCacheRegion in interface BasicQueryContract<CommonQueryContract>cacheRegion - the name of a query cache region, or null to indicate that the default region
should be used.this, for method chainingQuery.getCacheRegion()NativeQuery<T> setTimeout(int timeout)
QuerysetTimeout in interface BasicQueryContract<CommonQueryContract>timeout - the timeout in secondsthis, for method chainingQuery.getTimeout()NativeQuery<T> setFetchSize(int fetchSize)
QuerysetFetchSize in interface BasicQueryContract<CommonQueryContract>fetchSize - the fetch size hintthis, for method chainingQuery.getFetchSize()NativeQuery<T> setReadOnly(boolean readOnly)
QuerysetReadOnly in interface BasicQueryContract<CommonQueryContract>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 chainingTo set the default read-only/modifiable setting used for
entities and proxies that are loaded into the session:,
PersistenceContext.setDefaultReadOnly(boolean),
Read-only entities are not dirty-checked and snapshots of persistent
state are not maintained. Read-only entities can be modified, but
changes are not persisted.
When a proxy is initialized, the loaded entity will have the same
read-only/modifiable setting as the uninitialized
proxy has, regardless of the session's current setting.
The read-only/modifiable setting has no impact on entities/proxies
returned by the query that existed in the session before the query was executed.NativeQuery<T> setLockOptions(LockOptions lockOptions)
QueryQuery.setLockMode(String, LockMode).lockOptions - The lock options to apply to the query.this, for method chainingQuery.getLockOptions()NativeQuery<T> setLockMode(String alias, LockMode lockMode)
QueryLockOptions.
The effect of these alias-specific LockModes is somewhat dependent on the driver/database in use. Generally
speaking, for maximum portability, this method should only be used to mark that the rows corresponding to
the given alias should be included in pessimistic locking (LockMode.PESSIMISTIC_WRITE).alias - a query alias, or "this" for a collection filterlockMode - The lock mode to apply.this, for method chainingQuery.getLockOptions()NativeQuery<T> setComment(String comment)
Querycomment - The human-readable commentthis, for method chainingQuery.getComment()NativeQuery<T> addQueryHint(String hint)
QueryQueryHint, which is specific
to the JPA implementation and ignores DB vendor-specific hints. Instead, these are intended solely for the
vendor-specific hints, such as Oracle's optimizers. Multiple query hints are supported; the Dialect will
determine concatenation and placement.hint - The database specific query hint to add.<P> NativeQuery<T> setParameter(QueryParameter<P> parameter, P val)
QueryQuery.setParameter(QueryParameter, Object, Type)
should be used insteadparameter - The query parameter mementoval - the possibly-null parameter valuethis, for method chaining<P> NativeQuery<T> setParameter(Parameter<P> param, P value)
TypedQueryParameter object.setParameter in interface QuerysetParameter in interface TypedQuery<T>param - parameter objectvalue - parameter valueNativeQuery<T> setParameter(String name, Object val)
QueryQuery.setParameter(String, Object, Type)
should be used insteadsetParameter in interface QuerysetParameter in interface TypedQuery<T>name - the parameter nameval - the (possibly-null) parameter valuethis, for method chainingNativeQuery<T> setParameter(int position, Object val)
QueryQuery.setParameter(int, Object, Type)
should be used insteadsetParameter in interface QuerysetParameter in interface TypedQuery<T>position - the position of the parameter in the query
string, numbered from 0.val - the possibly-null parameter valuethis, for method chaining<P> NativeQuery<T> setParameter(QueryParameter<P> parameter, P val, Type type)
Queryparameter - The query parameter mementoval - the possibly-null parameter valuetype - the Hibernate typethis, for method chainingNativeQuery<T> setParameter(String name, Object val, Type type)
Queryname - the name of the parameterval - the possibly-null parameter valuetype - the Hibernate typethis, for method chainingNativeQuery<T> setParameter(int position, Object val, Type type)
Queryposition - the position of the parameter in the query
string, numbered from 0.val - the possibly-null parameter valuetype - the Hibernate typethis, for method chaining<P> NativeQuery<T> setParameter(QueryParameter<P> parameter, P val, TemporalType temporalType)
Queryparameter - The query parameter mementoval - the possibly-null parameter valuetemporalType - the temporal-type to use in binding the date/timethis, for method chaining<P> NativeQuery<T> setParameter(String name, P val, TemporalType temporalType)
Queryname - the parameter nameval - the possibly-null parameter valuetemporalType - the temporal-type to use in binding the date/timethis, for method chaining<P> NativeQuery<T> setParameter(int position, P val, TemporalType temporalType)
Queryposition - the position of the parameter in the query
string, numbered from 0.val - the possibly-null parameter valuetemporalType - the temporal-type to use in binding the date/timethis, for method chaining<P> NativeQuery<T> setParameterList(QueryParameter<P> parameter, Collection<P> values)
Queryparameter - the parameter mementovalues - a collection of values to listthis, for method chainingNativeQuery<T> setParameterList(String name, Collection values)
Queryname - the name of the parametervalues - a collection of values to listthis, for method chainingNativeQuery<T> setParameterList(String name, Collection values, Type type)
Queryname - the name of the parametervalues - a collection of values to listtype - the Hibernate type of the valuesthis, for method chainingNativeQuery<T> setParameterList(String name, Object[] values, Type type)
Queryname - the name of the parametervalues - a collection of values to listtype - the Hibernate type of the valuesthis, for method chainingNativeQuery<T> setParameterList(String name, Object[] values)
Queryname - the name of the parametervalues - a collection of values to listthis, for method chainingNativeQuery<T> setProperties(Object bean)
Querybean - any JavaBean or POJOthis, for method chainingNativeQuery<T> setProperties(Map bean)
Querybean - a java.util.Mapthis, for method chainingNativeQuery<T> setParameter(Parameter<Calendar> param, Calendar value, TemporalType temporalType)
TypedQueryjava.util.Calendar to a Parameter object.setParameter in interface QuerysetParameter in interface TypedQuery<T>param - parameter objectvalue - parameter valuetemporalType - temporal typeNativeQuery<T> setParameter(Parameter<Date> param, Date value, TemporalType temporalType)
TypedQueryjava.util.Date to a Parameter object.setParameter in interface QuerysetParameter in interface TypedQuery<T>param - parameter objectvalue - parameter valuetemporalType - temporal typeNativeQuery<T> setParameter(String name, Calendar value, TemporalType temporalType)
TypedQueryjava.util.Calendar to a named parameter.setParameter in interface QuerysetParameter in interface TypedQuery<T>name - parameter namevalue - parameter valuetemporalType - temporal typeNativeQuery<T> setParameter(String name, Date value, TemporalType temporalType)
TypedQueryjava.util.Date to a named parameter.setParameter in interface QuerysetParameter in interface TypedQuery<T>name - parameter namevalue - parameter valuetemporalType - temporal typeNativeQuery<T> setParameter(int position, Calendar value, TemporalType temporalType)
TypedQueryjava.util.Calendar to a positional
parameter.setParameter in interface QuerysetParameter in interface TypedQuery<T>position - positionvalue - parameter valuetemporalType - temporal typeNativeQuery<T> setParameter(int position, Date value, TemporalType temporalType)
TypedQueryjava.util.Date to a positional parameter.setParameter in interface QuerysetParameter in interface TypedQuery<T>position - positionvalue - parameter valuetemporalType - temporal typeNativeQuery<T> setFlushMode(FlushMode flushMode)
QuerysetFlushMode in interface BasicQueryContract<CommonQueryContract>flushMode - The new FlushMode to use.this, for method chainingQuery.getHibernateFlushMode()Copyright © 2019 JBoss by Red Hat. All rights reserved.