Top Description Inners Methods
org.hibernate

public Interface SQLQuery<T>

extends Query<T>, SynchronizeableQuery<T>
Known Direct Subinterfaces
org.hibernate.query.NativeQuery
Annotations
@Deprecated
Imports
java.util.Calendar, .Collection, .Date, .List, .Map, javax.persistence.FlushModeType, .Parameter, .TemporalType, org.hibernate.engine.query.spi.sql.NativeSQLQueryReturn, org.hibernate.query.NativeQuery, .QueryParameter, org.hibernate.type.Type

Deprecated

(since 5.2) use NativeQuery instead.

Represents a "native sql" query. Allows the user to define certain aspects about its execution, such as: In terms of result-set mapping, there are 3 approaches to defining:
Authors
Gavin King, Steve Ebersole

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static interface
SQLQuery.FetchReturn

Allows access to further control how join fetch returns are mapped back from result sets.

public static interface
SQLQuery.ReturnProperty

Allows access to further control how properties within a root or join fetch are mapped back from the result set.

public static interface
SQLQuery.RootReturn

Allows access to further control how root returns are mapped back from result sets.

Method Summary

Modifier and TypeMethod and Description
public SQLQuery<T>

Returns:

this, for method chaining
addEntity(String
The entity name that is the root return of the query.
entityName)

Deprecated as a consequence of SQLQuery being deprecated.
Declare a "root" entity, without specifying an alias.
public SQLQuery<T>

Returns:

this, for method chaining
addEntity(String
The SQL table alias
tableAlias, String
The entity name
entityName)

Deprecated as a consequence of SQLQuery being deprecated.
Declare a "root" entity.
public SQLQuery<T>

Returns:

this, for method chaining
addEntity(String
The SQL table alias
tableAlias, String
The entity name
entityName, LockMode
The lock mode for this return.
lockMode)

Deprecated as a consequence of SQLQuery being deprecated.
Declare a "root" entity, specifying a lock mode.
public SQLQuery<T>

Returns:

this, for method chaining
addEntity(Class<T>
The java type of the entity to add as a root
entityType)

Deprecated as a consequence of SQLQuery being deprecated.
Declare a "root" entity, without specifying an alias.
public SQLQuery<T>

Returns:

this, for method chaining
addEntity(String
The SQL table alias
tableAlias, Class<T>
The java type of the entity to add as a root
entityType)

Deprecated as a consequence of SQLQuery being deprecated.
Declare a "root" entity.
public SQLQuery<T>

Returns:

this, for method chaining
addEntity(String
The SQL table alias
tableAlias, Class<T>
The entity Class
entityClass, LockMode
The lock mode for this return.
lockMode)

Deprecated as a consequence of SQLQuery being deprecated.
Declare a "root" entity, specifying a lock mode.
public SQLQuery.FetchReturn

Returns:

The return config object for further control.
addFetch(String
The SQL table alias for the data to be mapped to this fetch
tableAlias, String
Identify the table alias of the owner of this association. Should match the alias of a previously added root or fetch
ownerTableAlias, String
The name of the property being join fetched.
joinPropertyName)

Declare a join fetch result.

public SQLQuery<T>

Returns:

this, for method chaining
addJoin(String
The SQL table alias for the data to be mapped to this fetch
tableAlias, String
The association path ([owner-alias].[property-name]).
path)

Deprecated as a consequence of SQLQuery being deprecated.
Declare a join fetch result.
public SQLQuery<T>

Returns:

this, for method chaining
addJoin(String
The SQL table alias for the data to be mapped to this fetch
tableAlias, String
Identify the table alias of the owner of this association. Should match the alias of a previously added root or fetch
ownerTableAlias, String
The name of the property being join fetched.
joinPropertyName)

Deprecated as a consequence of SQLQuery being deprecated.
Declare a join fetch result.
public SQLQuery<T>

Returns:

this, for method chaining
addJoin(String
The SQL table alias for the data to be mapped to this fetch
tableAlias, String
The association path ([owner-alias].[property-name]).
path, LockMode
The lock mode for this return.
lockMode)

Deprecated as a consequence of SQLQuery being deprecated.
Declare a join fetch result, specifying a lock mode.
public NativeQuery<T>
addQueryHint(String
The database specific query hint to add.
hint)

Redeclares org.hibernate.Query.addQueryHint.

Deprecated as a consequence of NativeQuery being deprecated.
Add a DB query hint to the SQL.
public SQLQuery.RootReturn

Returns:

The return config object for further control.
addRoot(String
The SQL table alias to map to this entity
tableAlias, String
The name of the entity.
entityName)

Add a new root return mapping, returning a SQLQuery.RootReturn to allow further definition.

public SQLQuery.RootReturn

Returns:

The return config object for further control.
addRoot(String
The SQL table alias to map to this entity
tableAlias, Class<T>
The java type of the entity.
entityType)

Add a new root return mapping, returning a SQLQuery.RootReturn to allow further definition.

public SQLQuery<T>

Returns:

this, for method chaining
addScalar(String
The column alias in the result-set to be processed as a scalar result
columnAlias)

Deprecated as a consequence of SQLQuery being deprecated.
Declare a scalar query result.
public SQLQuery<T>

Returns:

this, for method chaining
addScalar(String
The column alias in the result-set to be processed as a scalar result
columnAlias, Type
The Hibernate type as which to treat the value.
type)

Deprecated as a consequence of SQLQuery being deprecated.
Declare a scalar query result.
public SQLQuery<T>
addSynchronizedEntityClass(Class<T>
The class of the entity upon whose defined query spaces we should additionally synchronize.
entityClass)

Redeclares org.hibernate.SynchronizeableQuery.addSynchronizedEntityClass.

Deprecated as a consequence of SQLQuery being deprecated.
Adds an entity for (a) auto-flush checking and (b) query result cache invalidation checking.
public SQLQuery<T>
addSynchronizedEntityName(String
The name of the entity upon whose defined query spaces we should additionally synchronize.
entityName)

Redeclares org.hibernate.SynchronizeableQuery.addSynchronizedEntityName.

Deprecated as a consequence of SQLQuery being deprecated.
Adds an entity name for (a) auto-flush checking and (b) query result cache invalidation checking.
public SQLQuery<T>
addSynchronizedQuerySpace(String
The query space to be auto-flushed for this query.
querySpace)

Redeclares org.hibernate.SynchronizeableQuery.addSynchronizedQuerySpace.

Deprecated as a consequence of SQLQuery being deprecated.
Adds a query space.
public List<NativeSQLQueryReturn>

Returns:

The return descriptors
getQueryReturns()

Retrieve the returns associated with this query.

public boolean

Returns:

true if the query is known to be callable; false otherwise.
isCallable()

Is this native-SQL query known to be callable?

public NativeQuery<T>
setCacheable(boolean
Should the query results be cacheable?
cacheable)

Redeclares org.hibernate.Query.setCacheable.

Deprecated as a consequence of NativeQuery being deprecated.
Enable/disable second level query (result) caching for this query.
public NativeQuery<T>
setCacheMode(CacheMode
The new CacheMode to use.
cacheMode)

Redeclares org.hibernate.Query.setCacheMode.

Deprecated as a consequence of NativeQuery being deprecated.
(Re)set the current CacheMode in effect for this query.
public NativeQuery<T>
setCacheRegion(String
the name of a query cache region, or null to indicate that the default region should be used.
cacheRegion)

Redeclares org.hibernate.Query.setCacheRegion.

Deprecated as a consequence of NativeQuery being deprecated.
Set the name of the cache region where query results should be cached (if cached at all).
public NativeQuery<T>
setComment(String
The human-readable comment
comment)

Redeclares org.hibernate.Query.setComment.

Deprecated as a consequence of NativeQuery being deprecated.
Set the comment for this query.
public NativeQuery<T>
setFetchSize(int
the fetch size hint
fetchSize)

Redeclares org.hibernate.Query.setFetchSize.

Deprecated as a consequence of NativeQuery being deprecated.
Sets a JDBC fetch size hint for the query.
public NativeQuery<T>
setFlushMode(FlushModeType
flush mode
flushMode)

Redeclares org.hibernate.Query.setFlushMode.

Deprecated as a consequence of NativeQuery being deprecated.
Set the flush mode type to be used for the query execution.
public NativeQuery<T>
setFlushMode(FlushMode
The new FlushMode to use.
flushMode)

Redeclares org.hibernate.Query.setFlushMode.

Deprecated as a consequence of NativeQuery being deprecated.
(Re)set the current FlushMode in effect for this query.
public NativeQuery<T>
setHibernateFlushMode(FlushMode
The new FlushMode to use.
flushMode)

Redeclares as abstract: org.hibernate.Query.setHibernateFlushMode.

Deprecated as a consequence of NativeQuery being deprecated.
(Re)set the current FlushMode in effect for this query.
public NativeQuery<T>
setLockMode(String
a query alias, or "this" for a collection filter
alias, LockMode
The lock mode to apply.
lockMode)

Redeclares org.hibernate.Query.setLockMode.

Deprecated as a consequence of NativeQuery being deprecated.
Set the LockMode to use for specific alias (as defined in the query's FROM clause).
public NativeQuery<T>
setLockOptions(LockOptions
The lock options to apply to the query.
lockOptions)

Redeclares org.hibernate.Query.setLockOptions.

Deprecated as a consequence of NativeQuery being deprecated.
Set the lock options for the query.
public <P> NativeQuery<T>
setParameter(QueryParameter<P>
The query parameter memento
parameter, P
the possibly-null parameter value
val)

Redeclares org.hibernate.Query.setParameter.

Deprecated as a consequence of NativeQuery being deprecated.
Bind a query parameter using its inferred Type.
public <P> NativeQuery<T>
setParameter(Parameter<P>
parameter object
param, P
parameter value
value)

Redeclares org.hibernate.Query.setParameter.

Deprecated as a consequence of NativeQuery being deprecated.
Bind the value of a Parameter object.
public NativeQuery<T>
setParameter(String
the parameter name
name, Object
the (possibly-null) parameter value
val)

Redeclares org.hibernate.Query.setParameter.

Deprecated as a consequence of NativeQuery being deprecated.
Bind a named query parameter using its inferred Type.
public NativeQuery<T>
setParameter(int
the position of the parameter in the query string, numbered from 0.
position, Object
the possibly-null parameter value
val)

Redeclares org.hibernate.Query.setParameter.

Deprecated as a consequence of NativeQuery being deprecated.
Bind a positional query parameter using its inferred Type.
public <P> NativeQuery<T>
setParameter(QueryParameter<P>
The query parameter memento
parameter, P
the possibly-null parameter value
val, Type
the Hibernate type
type)

Redeclares org.hibernate.Query.setParameter.

Deprecated as a consequence of NativeQuery being deprecated.
Bind a query parameter using the supplied Type
public NativeQuery<T>
setParameter(String
the name of the parameter
name, Object
the possibly-null parameter value
val, Type
the Hibernate type
type)

Redeclares org.hibernate.Query.setParameter.

Deprecated as a consequence of NativeQuery being deprecated.
Bind a named query parameter using the supplied Type
public NativeQuery<T>
setParameter(int
the position of the parameter in the query string, numbered from 0.
position, Object
the possibly-null parameter value
val, Type
the Hibernate type
type)

Redeclares org.hibernate.Query.setParameter.

Deprecated as a consequence of NativeQuery being deprecated.
Bind a value to a JDBC-style query parameter.
public <P> NativeQuery<T>
setParameter(QueryParameter<P>
The query parameter memento
parameter, P
the possibly-null parameter value
val, TemporalType
the temporal-type to use in binding the date/time
temporalType)

Redeclares org.hibernate.Query.setParameter.

Deprecated as a consequence of NativeQuery being deprecated.
Bind a query parameter as some form of date/time using the indicated temporal-type.
public <P> NativeQuery<T>
setParameter(String
the parameter name
name, P
the possibly-null parameter value
val, TemporalType
the temporal-type to use in binding the date/time
temporalType)

Redeclares org.hibernate.Query.setParameter.

Deprecated as a consequence of NativeQuery being deprecated.
Bind a named query parameter as some form of date/time using the indicated temporal-type.
public <P> NativeQuery<T>
setParameter(int
the position of the parameter in the query string, numbered from 0.
position, P
the possibly-null parameter value
val, TemporalType
the temporal-type to use in binding the date/time
temporalType)

Redeclares org.hibernate.Query.setParameter.

Deprecated as a consequence of NativeQuery being deprecated.
Bind a positional query parameter as some form of date/time using the indicated temporal-type.
public NativeQuery<T>
setParameter(Parameter<Calendar>
parameter object
param, Calendar
parameter value
value, TemporalType
temporal type
temporalType)

Redeclares org.hibernate.Query.setParameter.

Deprecated as a consequence of NativeQuery being deprecated.
Bind an instance of java.util.Calendar to a Parameter object.
public NativeQuery<T>
setParameter(Parameter<Date>
parameter object
param, Date
parameter value
value, TemporalType
temporal type
temporalType)

Redeclares org.hibernate.Query.setParameter.

Deprecated as a consequence of NativeQuery being deprecated.
Bind an instance of java.util.Date to a Parameter object.
public NativeQuery<T>
setParameter(String
parameter name
name, Calendar
parameter value
value, TemporalType
temporal type
temporalType)

Redeclares org.hibernate.Query.setParameter, org.hibernate.Query.setParameter.

Deprecated as a consequence of NativeQuery being deprecated.
Bind an instance of java.util.Calendar to a named parameter.
public NativeQuery<T>
setParameter(String
parameter name
name, Date
parameter value
value, TemporalType
temporal type
temporalType)

Redeclares org.hibernate.Query.setParameter, org.hibernate.Query.setParameter.

Deprecated as a consequence of NativeQuery being deprecated.
Bind an instance of java.util.Date to a named parameter.
public NativeQuery<T>
setParameter(int
position
position, Calendar
parameter value
value, TemporalType
temporal type
temporalType)

Redeclares org.hibernate.Query.setParameter, org.hibernate.Query.setParameter.

Deprecated as a consequence of NativeQuery being deprecated.
Bind an instance of java.util.Calendar to a positional parameter.
public NativeQuery<T>
setParameter(int
position
position, Date
parameter value
value, TemporalType
temporal type
temporalType)

Redeclares org.hibernate.Query.setParameter, org.hibernate.Query.setParameter.

Deprecated as a consequence of NativeQuery being deprecated.
Bind an instance of java.util.Date to a positional parameter.
public <P> NativeQuery<T>
setParameterList(QueryParameter<P>
the parameter memento
parameter, Collection<P>
a collection of values to list
values)

Redeclares org.hibernate.Query.setParameterList.

Deprecated as a consequence of NativeQuery being deprecated.
Bind multiple values to a query parameter using its inferred Type.
public NativeQuery<T>
setParameterList(String
the name of the parameter
name, Collection<E>
a collection of values to list
values)

Redeclares org.hibernate.Query.setParameterList.

Deprecated as a consequence of NativeQuery being deprecated.
Bind multiple values to a named query parameter.
public NativeQuery<T>
setParameterList(String
the name of the parameter
name, Collection<E>
a collection of values to list
values, Type
the Hibernate type of the values
type)

Redeclares org.hibernate.Query.setParameterList.

Deprecated as a consequence of NativeQuery being deprecated.
Bind multiple values to a named query parameter.
public NativeQuery<T>
setParameterList(String
the name of the parameter
name, Object[]
a collection of values to list
values, Type
the Hibernate type of the values
type)

Redeclares org.hibernate.Query.setParameterList.

Deprecated as a consequence of NativeQuery being deprecated.
Bind multiple values to a named query parameter.
public NativeQuery<T>
setParameterList(String
the name of the parameter
name, Object[]
a collection of values to list
values)

Redeclares org.hibernate.Query.setParameterList.

Deprecated as a consequence of NativeQuery being deprecated.
Bind multiple values to a named query parameter.
public NativeQuery<T>
setProperties(Object
any JavaBean or POJO
bean)

Redeclares org.hibernate.Query.setProperties.

Deprecated as a consequence of NativeQuery being 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.
public NativeQuery<T>
setProperties(Map<K, V>
a java.util.Map
bean)

Redeclares org.hibernate.Query.setProperties.

Deprecated as a consequence of NativeQuery being 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.
public NativeQuery<T>
setReadOnly(boolean
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 mode
readOnly)

Redeclares org.hibernate.Query.setReadOnly.

Deprecated as a consequence of NativeQuery being deprecated.
Set the read-only/modifiable mode for entities and proxies loaded by this Query.
public SQLQuery<T>

Returns:

this, for method chaining
setResultSetMapping(String
The name of the mapping to use.
name)

Deprecated as a consequence of SQLQuery being deprecated.
Use a predefined named result-set mapping.
public NativeQuery<T>
setTimeout(int
the timeout in seconds
timeout)

Redeclares org.hibernate.Query.setTimeout.

Deprecated as a consequence of NativeQuery being deprecated.
Set the query timeout in seconds.
Inherited from org.hibernate.Query:
determineProperBooleanTypedetermineProperBooleanTypegetCacheModegetCacheRegiongetCommentgetFetchSizegetFlushModegetHibernateFirstResultgetHibernateFlushModegetHibernateMaxResultsgetLockOptionsgetNamedParametersgetParameterMetadatagetQueryOptionsgetQueryStringgetReturnAliasesgetReturnTypesgetTimeoutisCacheableisReadOnlyiteratelistscrollscrollsetBigDecimalsetBigDecimalsetBigIntegersetBigIntegersetBinarysetBinarysetBooleansetBooleansetBytesetBytesetCalendarsetCalendarsetCalendarDatesetCalendarDatesetCharactersetCharactersetDatesetDatesetDoublesetDoublesetEntitysetEntitysetFirstResultsetFloatsetFloatsetHibernateFirstResultsetHibernateMaxResultssetHintsetIntegersetIntegersetLocalesetLocalesetLockModesetLongsetLongsetMaxResultssetParameterListsetParameterListsetParameterListsetParameterListsetParameterssetResultTransformersetSerializablesetSerializablesetShortsetShortsetStringsetStringsetTextsetTextsetTimesetTimesetTimestampsetTimestampuniqueResult
Inherited from org.hibernate.SynchronizeableQuery:
addSynchronizedEntityClassaddSynchronizedEntityNameaddSynchronizedQuerySpaceaddSynchronizedTableaddSynchronizedTablegetSynchronizedQuerySpaces