NativeQuery (hibernate-core JavaDocs)

All Superinterfaces:

CommonQueryContract, Query, SynchronizeableQuery, TypedQuery<T>

All Known Subinterfaces:

NativeQueryImplementor<R>
```
public interface NativeQuery<T>
extends Query<T>, SynchronizeableQuery
```
Represents a native (SQL) query. Allows the user to define certain aspects about its execution, such as:
- result-set value mapping (see below)
- Tables used via 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.
In terms of result-set mapping, there are 3 approaches to defining:
- If this represents a named sql query, the mapping could be associated with the query as part of its metadata
- A pre-defined (defined in metadata and named) mapping can be associated via QueryProducer.createNativeQuery(String, String)
- Defined locally per the various 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

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`NativeQuery.FetchReturn` Allows access to further control how join fetch returns are mapped back from result sets.
`static interface`	`NativeQuery.InstantiationResultNode<J>`
`static interface`	`NativeQuery.ResultNode` Simple unification interface for all returns from the various `#addXYZ` methods .
`static interface`	`NativeQuery.ReturnableResultNode` ResultNode which can be a query result
`static interface`	`NativeQuery.ReturnProperty` Allows access to further control how properties within a root or join fetch are mapped back from the result set.
`static interface`	`NativeQuery.RootReturn` Allows access to further control how root returns are mapped back from result sets.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`NativeQuery<T>`	`addAttributeResult(String columnAlias, Class<?> entityJavaType, String attributePath)` Defines a result based on a specified attribute.
`NativeQuery<T>`	`addAttributeResult(String columnAlias, SingularAttribute<?,?> attribute)` Defines a result based on a specified attribute.
`NativeQuery<T>`	`addAttributeResult(String columnAlias, String entityName, String attributePath)` Defines a result based on a specified attribute.
`NativeQuery<T>`	`addEntity(Class entityType)` Declare a "root" entity, without specifying an alias.
`NativeQuery<T>`	`addEntity(String entityName)` Declare a "root" entity, without specifying an alias.
`NativeQuery<T>`	`addEntity(String tableAlias, Class entityType)` Declare a "root" entity.
`NativeQuery<T>`	`addEntity(String tableAlias, Class entityClass, LockMode lockMode)` Declare a "root" entity, specifying a lock mode.
`NativeQuery<T>`	`addEntity(String tableAlias, String entityName)` Declare a "root" entity.
`NativeQuery<T>`	`addEntity(String tableAlias, String entityName, LockMode lockMode)` Declare a "root" entity, specifying a lock mode.
`NativeQuery.FetchReturn`	`addFetch(String tableAlias, String ownerTableAlias, String joinPropertyName)` Declare a join fetch result.
`<J> NativeQuery.InstantiationResultNode<J>`	`addInstantiation(Class<J> targetJavaType)`
`NativeQuery<T>`	`addJoin(String tableAlias, String path)` Declare a join fetch result.
`NativeQuery<T>`	`addJoin(String tableAlias, String path, LockMode lockMode)` Declare a join fetch result, specifying a lock mode.
`NativeQuery<T>`	`addJoin(String tableAlias, String ownerTableAlias, String joinPropertyName)` Declare a join fetch result.
`NativeQuery<T>`	`addQueryHint(String hint)` Add a DB query hint to the SQL.
`NativeQuery.RootReturn`	`addRoot(String tableAlias, Class entityType)` Add a new root return mapping, returning a `NativeQuery.RootReturn` to allow further definition.
`NativeQuery.RootReturn`	`addRoot(String tableAlias, String entityName)` Add a new root return mapping, returning a `NativeQuery.RootReturn` to allow further definition.
`NativeQuery<T>`	`addScalar(String columnAlias)` Declare a scalar query result.
`NativeQuery<T>`	`addScalar(String columnAlias, BasicDomainType type)` Declare a scalar query result.
`NativeQuery<T>`	`addScalar(String columnAlias, Class<?> javaType)` Declare a scalar query result using the specified result type.
`<C> NativeQuery<T>`	`addScalar(String columnAlias, Class<C> relationalJavaType, AttributeConverter<?,C> converter)` Declare a scalar query result with an explicit conversion
`<C> NativeQuery<T>`	`addScalar(String columnAlias, Class<C> relationalJavaType, Class<? extends AttributeConverter<?,C>> converter)` Declare a scalar query result with an explicit conversion
`<O,R> NativeQuery<T>`	`addScalar(String columnAlias, Class<O> domainJavaType, Class<R> jdbcJavaType, AttributeConverter<O,R> converter)` Declare a scalar query result with an explicit conversion
`<O,R> NativeQuery<T>`	`addScalar(String columnAlias, Class<O> domainJavaType, Class<R> jdbcJavaType, Class<? extends AttributeConverter<O,R>> converter)` Declare a scalar query result with an explicit conversion
`NativeQuery<T>`	`addSynchronizedEntityClass(Class entityClass)` Adds an entity for (a) auto-flush checking and (b) query result cache invalidation checking.
`NativeQuery<T>`	`addSynchronizedEntityName(String entityName)` Adds an entity name for (a) auto-flush checking and (b) query result cache invalidation checking.
`NativeQuery<T>`	`addSynchronizedQuerySpace(String querySpace)` Adds a query space.
`NativeQuery<T>`	`setCacheable(boolean cacheable)` Enable/disable second level query (result) caching for this query.
`NativeQuery<T>`	`setCacheMode(CacheMode cacheMode)` (Re)set the current CacheMode in effect for this query.
`NativeQuery<T>`	`setCacheRegion(String cacheRegion)` Set the name of the cache region where query results should be cached (if cached at all).
`NativeQuery<T>`	`setComment(String comment)` Set the comment for this query.
`NativeQuery<T>`	`setFetchSize(int fetchSize)` Sets a JDBC fetch size hint for the query.
`NativeQuery<T>`	`setFirstResult(int startPosition)`
`NativeQuery<T>`	`setFlushMode(FlushModeType flushMode)`
`NativeQuery<T>`	`setHibernateFlushMode(FlushMode flushMode)` (Re)set the current FlushMode in effect for this query.
`NativeQuery<T>`	`setHint(String hintName, Object value)`
`NativeQuery<T>`	`setLockMode(LockModeType lockMode)`
`NativeQuery<T>`	`setLockMode(String alias, LockMode lockMode)` Set the LockMode to use for specific alias (as defined in the query's `FROM` clause).
`NativeQuery<T>`	`setLockOptions(LockOptions lockOptions)` Set the lock options for the query.
`NativeQuery<T>`	`setMaxResults(int maxResult)`
`NativeQuery<T>`	`setParameter(int position, Calendar value, TemporalType temporalType)`
`NativeQuery<T>`	`setParameter(int position, Date value, TemporalType temporalType)`
`NativeQuery<T>`	`setParameter(int position, Instant value, TemporalType temporalType)`
`NativeQuery<T>`	`setParameter(int position, LocalDateTime value, TemporalType temporalType)`
`NativeQuery<T>`	`setParameter(int position, Object value)` Bind a positional query parameter using its inferred Type.
`NativeQuery<T>`	`setParameter(int position, Object val, AllowableParameterType type)` Bind a value to a JDBC-style query parameter.
`NativeQuery<T>`	`setParameter(int position, Object val, TemporalType temporalType)` Bind a positional query parameter as some form of date/time using the indicated temporal-type.
`NativeQuery<T>`	`setParameter(int position, OffsetDateTime value, TemporalType temporalType)`
`NativeQuery<T>`	`setParameter(int position, ZonedDateTime value, TemporalType temporalType)`
`NativeQuery<T>`	`setParameter(Parameter<Calendar> param, Calendar value, TemporalType temporalType)`
`NativeQuery<T>`	`setParameter(Parameter<Date> param, Date value, TemporalType temporalType)`
`NativeQuery<T>`	`setParameter(Parameter<Instant> param, Instant value, TemporalType temporalType)`
`NativeQuery<T>`	`setParameter(Parameter<LocalDateTime> param, LocalDateTime value, TemporalType temporalType)`
`NativeQuery<T>`	`setParameter(Parameter<OffsetDateTime> param, OffsetDateTime value, TemporalType temporalType)`
`<P> NativeQuery<T>`	`setParameter(Parameter<P> param, P value)`
`NativeQuery<T>`	`setParameter(Parameter<ZonedDateTime> param, ZonedDateTime value, TemporalType temporalType)`
`<P> NativeQuery<T>`	`setParameter(QueryParameter<P> parameter, P val)` Bind a query parameter using its inferred Type.
`<P> NativeQuery<T>`	`setParameter(QueryParameter<P> parameter, P val, AllowableParameterType type)` Bind a query parameter using the supplied Type
`<P> NativeQuery<T>`	`setParameter(QueryParameter<P> parameter, P val, TemporalType temporalType)` Bind a query parameter as some form of date/time using the indicated temporal-type.
`NativeQuery<T>`	`setParameter(String name, Calendar value, TemporalType temporalType)`
`NativeQuery<T>`	`setParameter(String name, Date value, TemporalType temporalType)`
`NativeQuery<T>`	`setParameter(String name, Instant value, TemporalType temporalType)`
`NativeQuery<T>`	`setParameter(String name, LocalDateTime value, TemporalType temporalType)`
`NativeQuery<T>`	`setParameter(String name, Object value)` Bind a named query parameter using its inferred Type.
`NativeQuery<T>`	`setParameter(String name, Object val, AllowableParameterType type)` Bind a named query parameter using the supplied Type
`NativeQuery<T>`	`setParameter(String name, Object val, TemporalType temporalType)` Bind a named query parameter as some form of date/time using the indicated temporal-type.
`NativeQuery<T>`	`setParameter(String name, OffsetDateTime value, TemporalType temporalType)`
`NativeQuery<T>`	`setParameter(String name, ZonedDateTime value, TemporalType temporalType)`
`NativeQuery<T>`	`setParameterList(int position, Collection values)` Bind multiple values to a positional query parameter.
`NativeQuery<T>`	`setParameterList(int position, Collection values, AllowableParameterType type)` Bind multiple values to a positional query parameter.
`NativeQuery<T>`	`setParameterList(int position, Collection values, Class type)` Bind multiple values to a positional query parameter.
`NativeQuery<T>`	`setParameterList(int position, Object[] values)` Bind multiple values to a named query parameter.
`NativeQuery<T>`	`setParameterList(int position, Object[] values, AllowableParameterType type)` Bind multiple values to a named query parameter.
`<P> NativeQuery<T>`	`setParameterList(QueryParameter<P> parameter, Collection<P> values)` Bind multiple values to a query parameter using its inferred Type.
`NativeQuery<T>`	`setParameterList(String name, Collection values)` Bind multiple values to a named query parameter.
`NativeQuery<T>`	`setParameterList(String name, Collection values, AllowableParameterType type)` Bind multiple values to a named query parameter.
`NativeQuery<T>`	`setParameterList(String name, Collection values, Class type)` Bind multiple values to a named query parameter.
`NativeQuery<T>`	`setParameterList(String name, Object[] values)` Bind multiple values to a named query parameter.
`NativeQuery<T>`	`setParameterList(String name, Object[] values, AllowableParameterType type)` Bind multiple values to a named query parameter.
`NativeQuery<T>`	`setProperties(Map bean)` 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)` 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)` Set the read-only/modifiable mode for entities and proxies loaded by this Query.
`NativeQuery<T>`	`setResultListTransformer(ResultListTransformer transformer)`
`NativeQuery<T>`	`setResultTransformer(ResultTransformer transformer)`
`NativeQuery<T>`	`setTimeout(int timeout)` Set the query timeout in seconds.
`NativeQuery<T>`	`setTupleTransformer(TupleTransformer<T> transformer)`

Methods inherited from interface org.hibernate.query.Query
applyFetchGraph, applyGraph, applyLoadGraph, getComment, getLockOptions, getParameterMetadata, getQueryOptions, getQueryString, getResultList, getSession, getSingleResult, list, scroll, scroll, stream, uniqueResult, uniqueResultOptional

Methods inherited from interface javax.persistence.TypedQuery
getResultStream

Methods inherited from interface javax.persistence.Query
executeUpdate, getFirstResult, getFlushMode, getHints, getLockMode, getMaxResults, getParameter, getParameter, getParameter, getParameter, getParameters, getParameterValue, getParameterValue, getParameterValue, isBound, unwrap

Methods inherited from interface org.hibernate.query.CommonQueryContract
getCacheMode, getCacheRegion, getFetchSize, getHibernateFlushMode, getTimeout, isCacheable, isReadOnly

Methods inherited from interface org.hibernate.query.SynchronizeableQuery
getSynchronizedQuerySpaces

- Method Detail
 - addScalar
```
NativeQuery<T> addScalar(String columnAlias)
```
 Declare a scalar query result. Hibernate will attempt to automatically detect the underlying type.
 Functions like <return-scalar/> in hbm.xml or ColumnResult in annotations
 
 Parameters:
 
 columnAlias - The column alias in the result-set to be processed as a scalar result
 
 Returns:
 
 this, for method chaining
 - addScalar
```
NativeQuery<T> addScalar(String columnAlias,
 BasicDomainType type)
```
 Declare a scalar query result.
 Functions like <return-scalar/> in hbm.xml or ColumnResult in annotations
 
 Parameters:
 
 columnAlias - The column alias in the result-set to be processed as a scalar result
 
 type - The Hibernate type as which to treat the value.
 
 Returns:
 
 this, for method chaining
 - addScalar
```
NativeQuery<T> addScalar(String columnAlias,
 Class<?> javaType)
```
 Declare a scalar query result using the specified result type. Hibernate will implicitly determine an appropriate conversion, if it can. Otherwise an exception will be thrown
 
 Returns:
 
 this, for method chaining
 
 Since:
 
 6.0
 - addScalar
```
<C> NativeQuery<T> addScalar(String columnAlias,
 Class<C> relationalJavaType,
 AttributeConverter<?,C> converter)
```
 Declare a scalar query result with an explicit conversion
 
 Parameters:
 
 relationalJavaType - The Java type expected by the converter as its "relational" type.
 
 converter - The conversion to apply. Consumes the JDBC value based on `relationalJavaType`.
 
 Returns:
 
 this, for method chaining
 
 Since:
 
 6.0
 - addScalar
```
<O,R> NativeQuery<T> addScalar(String columnAlias,
 Class<O> domainJavaType,
 Class<R> jdbcJavaType,
 AttributeConverter<O,R> converter)
```
 Declare a scalar query result with an explicit conversion
 
 Parameters:
 
 jdbcJavaType - The Java type expected by the converter as its "relational model" type.
 
 domainJavaType - The Java type expected by the converter as its "object model" type.
 
 converter - The conversion to apply. Consumes the JDBC value based on `relationalJavaType`.
 
 Returns:
 
 this, for method chaining
 
 Since:
 
 6.0
 - addScalar
```
<C> NativeQuery<T> addScalar(String columnAlias,
 Class<C> relationalJavaType,
 Class<? extends AttributeConverter<?,C>> converter)
```
 Declare a scalar query result with an explicit conversion
 
 Parameters:
 
 relationalJavaType - The Java type expected by the converter as its "relational" type.
 
 converter - The conversion to apply. Consumes the JDBC value based on `relationalJavaType`.
 
 Returns:
 
 this, for method chaining
 
 Since:
 
 6.0
 - addScalar
```
<O,R> NativeQuery<T> addScalar(String columnAlias,
 Class<O> domainJavaType,
 Class<R> jdbcJavaType,
 Class<? extends AttributeConverter<O,R>> converter)
```
 Declare a scalar query result with an explicit conversion
 
 Parameters:
 
 jdbcJavaType - The Java type expected by the converter as its "relational model" type.
 
 domainJavaType - The Java type expected by the converter as its "object model" type.
 
 converter - The conversion to apply. Consumes the JDBC value based on `jdbcJavaType`.
 
 Returns:
 
 this, for method chaining
 
 Since:
 
 6.0
 - addInstantiation
```
<J> NativeQuery.InstantiationResultNode<J> addInstantiation(Class<J> targetJavaType)
```
 - addAttributeResult
```
NativeQuery<T> addAttributeResult(String columnAlias,
 Class<?> entityJavaType,
 String attributePath)
```
 Defines a result based on a specified attribute. Differs from adding a scalar in that any conversions or other semantics defined on the attribute are automatically applied to the mapping
 
 Returns:
 
 this, for method chaining
 
 Since:
 
 6.0
 - addAttributeResult
```
NativeQuery<T> addAttributeResult(String columnAlias,
 String entityName,
 String attributePath)
```
 Defines a result based on a specified attribute. Differs from adding a scalar in that any conversions or other semantics defined on the attribute are automatically applied to the mapping
 
 Returns:
 
 this, for method chaining
 
 Since:
 
 6.0
 - addAttributeResult
```
NativeQuery<T> addAttributeResult(String columnAlias,
 SingularAttribute<?,?> attribute)
```
 Defines a result based on a specified attribute. Differs from adding a scalar in that any conversions or other semantics defined on the attribute are automatically applied to the mapping. This form accepts the JPA Attribute mapping describing the attribute
 
 Returns:
 
 this, for method chaining
 
 Since:
 
 6.0
 - addRoot
```
NativeQuery.RootReturn addRoot(String tableAlias,
 String entityName)
```
 Add a new root return mapping, returning a NativeQuery.RootReturn to allow further definition.
 
 Parameters:
 
 tableAlias - The SQL table alias to map to this entity
 
 entityName - The name of the entity.
 
 Returns:
 
 The return config object for further control.
 
 Since:
 
 3.6
 - addRoot
```
NativeQuery.RootReturn addRoot(String tableAlias,
 Class entityType)
```
 Add a new root return mapping, returning a NativeQuery.RootReturn to allow further definition.
 
 Parameters:
 
 tableAlias - The SQL table alias to map to this entity
 
 entityType - The java type of the entity.
 
 Returns:
 
 The return config object for further control.
 
 Since:
 
 3.6
 - addEntity
```
NativeQuery<T> addEntity(String entityName)
```
 Declare a "root" entity, without specifying an alias. The expectation here is that the table alias is the same as the unqualified entity name
 Use addRoot(java.lang.String, java.lang.String) if you need further control of the mapping
 
 Parameters:
 
 entityName - The entity name that is the root return of the query.
 
 Returns:
 
 this, for method chaining
 - addEntity
```
NativeQuery<T> addEntity(String tableAlias,
 String entityName)
```
 Declare a "root" entity.
 
 Parameters:
 
 tableAlias - The SQL table alias
 
 entityName - The entity name
 
 Returns:
 
 this, for method chaining
 - addEntity
```
NativeQuery<T> addEntity(String tableAlias,
 String entityName,
 LockMode lockMode)
```
 Declare a "root" entity, specifying a lock mode.
 
 Parameters:
 
 tableAlias - The SQL table alias
 
 entityName - The entity name
 
 lockMode - The lock mode for this return.
 
 Returns:
 
 this, for method chaining
 - addEntity
```
NativeQuery<T> addEntity(Class entityType)
```
 Declare a "root" entity, without specifying an alias. The expectation here is that the table alias is the same as the unqualified entity name
 
 Parameters:
 
 entityType - The java type of the entity to add as a root
 
 Returns:
 
 this, for method chaining
 - addEntity
```
NativeQuery<T> addEntity(String tableAlias,
 Class entityType)
```
 Declare a "root" entity.
 
 Parameters:
 
 tableAlias - The SQL table alias
 
 entityType - The java type of the entity to add as a root
 
 Returns:
 
 this, for method chaining
 - addEntity
```
NativeQuery<T> addEntity(String tableAlias,
 Class entityClass,
 LockMode lockMode)
```
 Declare a "root" entity, specifying a lock mode.
 
 Parameters:
 
 tableAlias - The SQL table alias
 
 entityClass - The entity Class
 
 lockMode - The lock mode for this return.
 
 Returns:
 
 this, for method chaining
 - addFetch
```
NativeQuery.FetchReturn addFetch(String tableAlias,
 String ownerTableAlias,
 String joinPropertyName)
```
 Declare a join fetch result.
 
 Parameters:
 
 tableAlias - The SQL table alias for the data to be mapped to this fetch
 
 ownerTableAlias - Identify the table alias of the owner of this association. Should match the alias of a previously added root or fetch
 
 joinPropertyName - The name of the property being join fetched.
 
 Returns:
 
 The return config object for further control.
 
 Since:
 
 3.6
 - addJoin
```
NativeQuery<T> addJoin(String tableAlias,
 String path)
```
 Declare a join fetch result.
 
 Parameters:
 
 tableAlias - The SQL table alias for the data to be mapped to this fetch
 
 path - The association path ([owner-alias].[property-name]).
 
 Returns:
 
 this, for method chaining
 - addJoin
```
NativeQuery<T> addJoin(String tableAlias,
 String ownerTableAlias,
 String joinPropertyName)
```
 Declare a join fetch result.
 
 Parameters:
 
 tableAlias - The SQL table alias for the data to be mapped to this fetch
 
 ownerTableAlias - Identify the table alias of the owner of this association. Should match the alias of a previously added root or fetch
 
 joinPropertyName - The name of the property being join fetched.
 
 Returns:
 
 this, for method chaining
 
 Since:
 
 3.6
 - addJoin
```
NativeQuery<T> addJoin(String tableAlias,
 String path,
 LockMode lockMode)
```
 Declare a join fetch result, specifying a lock mode.
 
 Parameters:
 
 tableAlias - The SQL table alias for the data to be mapped to this fetch
 
 path - The association path ([owner-alias].[property-name]).
 
 lockMode - The lock mode for this return.
 
 Returns:
 
 this, for method chaining
 - addSynchronizedQuerySpace
```
NativeQuery<T> addSynchronizedQuerySpace(String querySpace)
```
 Description copied from interface: SynchronizeableQuery
 
 Adds a query space.
 
 Specified by:
 
 addSynchronizedQuerySpace in interface SynchronizeableQuery
 
 Parameters:
 
 querySpace - The query space to be auto-flushed for this query.
 
 Returns:
 
 this, for method chaining
 - addSynchronizedEntityName
```
NativeQuery<T> addSynchronizedEntityName(String entityName)
 throws MappingException
```
 Description copied from interface: SynchronizeableQuery
 
 Adds an entity name for (a) auto-flush checking and (b) query result cache invalidation checking. Same as SynchronizeableQuery.addSynchronizedQuerySpace(java.lang.String) for all tables associated with the given entity.
 
 Specified by:
 
 addSynchronizedEntityName in interface SynchronizeableQuery
 
 Parameters:
 
 entityName - The name of the entity upon whose defined query spaces we should additionally synchronize.
 
 Returns:
 
 this, for method chaining
 
 Throws:
 
 MappingException - Indicates the given name could not be resolved as an entity
 - addSynchronizedEntityClass
```
NativeQuery<T> addSynchronizedEntityClass(Class entityClass)
 throws MappingException
```
 Description copied from interface: SynchronizeableQuery
 
 Adds an entity for (a) auto-flush checking and (b) query result cache invalidation checking. Same as SynchronizeableQuery.addSynchronizedQuerySpace(java.lang.String) for all tables associated with the given entity.
 
 Specified by:
 
 addSynchronizedEntityClass in interface SynchronizeableQuery
 
 Parameters:
 
 entityClass - The class of the entity upon whose defined query spaces we should additionally synchronize.
 
 Returns:
 
 this, for method chaining
 
 Throws:
 
 MappingException - Indicates the given class could not be resolved as an entity
 - setHibernateFlushMode
```
NativeQuery<T> setHibernateFlushMode(FlushMode flushMode)
```
 Description copied from interface: CommonQueryContract
 
 (Re)set the current FlushMode in effect for this query.
 
 Specified by:
 
 setHibernateFlushMode in interface CommonQueryContract
 
 Parameters:
 
 flushMode - The new FlushMode to use.
 
 Returns:
 
 this, for method chaining
 
 See Also:
 
 Session.getHibernateFlushMode(), CommonQueryContract.getHibernateFlushMode()
 - setFlushMode
```
NativeQuery<T> setFlushMode(FlushModeType flushMode)
```
 Specified by:
 
 setFlushMode in interface Query
 
 Specified by:
 
 setFlushMode in interface TypedQuery<T>
 - setCacheMode
```
NativeQuery<T> setCacheMode(CacheMode cacheMode)
```
 Description copied from interface: CommonQueryContract
 
 (Re)set the current CacheMode in effect for this query.
 
 Specified by:
 
 setCacheMode in interface CommonQueryContract
 
 Parameters:
 
 cacheMode - The new CacheMode to use.
 
 Returns:
 
 this, for method chaining
 
 See Also:
 
 CommonQueryContract.getCacheMode()
 - setCacheable
```
NativeQuery<T> setCacheable(boolean cacheable)
```
 Description copied from interface: CommonQueryContract
 
 Enable/disable second level query (result) caching for this query.
 
 Specified by:
 
 setCacheable in interface CommonQueryContract
 
 Parameters:
 
 cacheable - Should the query results be cacheable?
 
 Returns:
 
 this, for method chaining
 
 See Also:
 
 CommonQueryContract.isCacheable()
 - setCacheRegion
```
NativeQuery<T> setCacheRegion(String cacheRegion)
```
 Description copied from interface: CommonQueryContract
 
 Set the name of the cache region where query results should be cached (if cached at all).
 
 Specified by:
 
 setCacheRegion in interface CommonQueryContract
 
 Parameters:
 
 cacheRegion - the name of a query cache region, or null to indicate that the default region should be used.
 
 Returns:
 
 this, for method chaining
 
 See Also:
 
 CommonQueryContract.getCacheRegion()
 - setTimeout
```
NativeQuery<T> setTimeout(int timeout)
```
 Description copied from interface: CommonQueryContract
 
 Set the query timeout in seconds. 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.
 
 Specified by:
 
 setTimeout in interface CommonQueryContract
 
 Parameters:
 
 timeout - the timeout in seconds
 
 Returns:
 
 this, for method chaining
 
 See Also:
 
 CommonQueryContract.getTimeout()
 - setFetchSize
```
NativeQuery<T> setFetchSize(int fetchSize)
```
 Description copied from interface: CommonQueryContract
 
 Sets a JDBC fetch size hint for the query.
 
 Specified by:
 
 setFetchSize in interface CommonQueryContract
 
 Parameters:
 
 fetchSize - the fetch size hint
 
 Returns:
 
 this, for method chaining
 
 See Also:
 
 CommonQueryContract.getFetchSize()
 - setReadOnly
```
NativeQuery<T> setReadOnly(boolean readOnly)
```
 Description copied from interface: CommonQueryContract
 
 Set the read-only/modifiable mode for entities and proxies loaded by this Query. This setting overrides the default setting for the persistence context.
 
 Specified by:
 
 setReadOnly in interface CommonQueryContract
 
 Parameters:
 
 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 mode
 
 Returns:
 
 this, for method chaining
 
 See Also:
 
 To 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 beforeQuery the query was executed.
 - setLockOptions
```
NativeQuery<T> setLockOptions(LockOptions lockOptions)
```
 Description copied from interface: Query
 Set the lock options for the query. Specifically only the following are taken into consideration:
 For alias-specific locking, use Query.setLockMode(String, LockMode).
 Parameters:
 
 lockOptions - The lock options to apply to the query.
 
 Returns:
 
 this, for method chaining
 
 See Also:
 
 Query.getLockOptions()
 - setLockMode
```
NativeQuery<T> setLockMode(String alias,
 LockMode lockMode)
```
 Description copied from interface: Query
 
 Set the LockMode to use for specific alias (as defined in the query's FROM clause).
 The alias-specific lock modes specified here are added to the query's internal LockOptions.
 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).
 
 Parameters:
 
 alias - a query alias, or "this" for a collection filter
 
 lockMode - The lock mode to apply.
 
 Returns:
 
 this, for method chaining
 
 See Also:
 
 Query.getLockOptions()
 - setComment
```
NativeQuery<T> setComment(String comment)
```
 Description copied from interface: Query
 
 Set the comment for this query.
 
 Parameters:
 
 comment - The human-readable comment
 
 Returns:
 
 this, for method chaining
 
 See Also:
 
 Query.getComment()
 - addQueryHint
```
NativeQuery<T> addQueryHint(String hint)
```
 Description copied from interface: Query
 
 Add a DB query hint to the SQL. These differ from JPA's QueryHint and Query.getHints(), 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.
 
 Parameters:
 
 hint - The database specific query hint to add.
 - setMaxResults
```
NativeQuery<T> setMaxResults(int maxResult)
```
 Specified by:
 
 setMaxResults in interface Query
 
 Specified by:
 
 setMaxResults in interface TypedQuery<T>
 - setFirstResult
```
NativeQuery<T> setFirstResult(int startPosition)
```
 Specified by:
 
 setFirstResult in interface Query
 
 Specified by:
 
 setFirstResult in interface TypedQuery<T>
 - setHint
```
NativeQuery<T> setHint(String hintName,
 Object value)
```
 Specified by:
 
 setHint in interface Query
 
 Specified by:
 
 setHint in interface TypedQuery<T>
 - setLockMode
```
NativeQuery<T> setLockMode(LockModeType lockMode)
```
 Specified by:
 
 setLockMode in interface Query
 
 Specified by:
 
 setLockMode in interface TypedQuery<T>
 - setTupleTransformer
```
NativeQuery<T> setTupleTransformer(TupleTransformer<T> transformer)
```
 - setResultListTransformer
```
NativeQuery<T> setResultListTransformer(ResultListTransformer transformer)
```
 - setResultTransformer
```
NativeQuery<T> setResultTransformer(ResultTransformer transformer)
```
 - setParameter
```
NativeQuery<T> setParameter(String name,
 Object value)
```
 Description copied from interface: Query
 
 Bind a named query parameter using its inferred Type. If the parameter is defined in such a way that the Type cannot be inferred from its usage context then use of this form of binding is not allowed, and Query.setParameter(String, Object, AllowableParameterType) should be used instead
 
 Specified by:
 
 setParameter in interface Query
 
 Specified by:
 
 setParameter in interface TypedQuery<T>
 
 Parameters:
 
 name - the parameter name
 
 value - the (possibly-null) parameter value
 
 Returns:
 
 this, for method chaining
 - setParameter
```
NativeQuery<T> setParameter(int position,
 Object value)
```
 Description copied from interface: Query
 
 Bind a positional query parameter using its inferred Type. If the parameter is defined in such a way that the Type cannot be inferred from its usage context then use of this form of binding is not allowed, and Query.setParameter(int, Object, AllowableParameterType) should be used instead
 
 Specified by:
 
 setParameter in interface Query
 
 Specified by:
 
 setParameter in interface TypedQuery<T>
 
 Parameters:
 
 position - the position of the parameter in the query string, numbered from 0.
 
 value - the possibly-null parameter value
 
 Returns:
 
 this, for method chaining
 - setParameter
```
 NativeQuery<T> setParameter(QueryParameter parameter,
 P val)
```
 Description copied from interface: Query
 
 Bind a query parameter using its inferred Type. If the parameter is defined in such a way that the Type cannot be inferred from its usage context then use of this form of binding is not allowed, and Query.setParameter(QueryParameter, Object, AllowableParameterType) should be used instead
 
 Parameters:
 
 parameter - The query parameter memento
 
 val - the possibly-null parameter value
 
 Returns:
 
 this, for method chaining
 - setParameter
```
NativeQuery<T> setParameter(Parameter<Instant> param,
 Instant value,
 TemporalType temporalType)
```
 - setParameter
```
NativeQuery<T> setParameter(Parameter<LocalDateTime> param,
 LocalDateTime value,
 TemporalType temporalType)
```
 - setParameter
```
NativeQuery<T> setParameter(Parameter<ZonedDateTime> param,
 ZonedDateTime value,
 TemporalType temporalType)
```
 - setParameter
```
NativeQuery<T> setParameter(Parameter<OffsetDateTime> param,
 OffsetDateTime value,
 TemporalType temporalType)
```
 - setParameter
```
NativeQuery<T> setParameter(String name,
 Instant value,
 TemporalType temporalType)
```
 - setParameter
```
NativeQuery<T> setParameter(String name,
 LocalDateTime value,
 TemporalType temporalType)
```
 - setParameter
```
NativeQuery<T> setParameter(String name,
 ZonedDateTime value,
 TemporalType temporalType)
```
 - setParameter
```
NativeQuery<T> setParameter(String name,
 OffsetDateTime value,
 TemporalType temporalType)
```
 - setParameter
```
NativeQuery<T> setParameter(int position,
 Instant value,
 TemporalType temporalType)
```
 - setParameter
```
NativeQuery<T> setParameter(int position,
 LocalDateTime value,
 TemporalType temporalType)
```
 - setParameter
```
NativeQuery<T> setParameter(int position,
 ZonedDateTime value,
 TemporalType temporalType)
```
 - setParameter
```
NativeQuery<T> setParameter(int position,
 OffsetDateTime value,
 TemporalType temporalType)
```
 - setParameter
```
 NativeQuery<T> setParameter(Parameter param,
 P value)
```
 Specified by:
 
 setParameter in interface Query
 
 Specified by:
 
 setParameter in interface TypedQuery<T>
 - setParameter
```
NativeQuery<T> setParameter(String name,
 Object val,
 TemporalType temporalType)
```
 Description copied from interface: Query
 
 Bind a named query parameter as some form of date/time using the indicated temporal-type.
 
 Parameters:
 
 name - the parameter name
 
 val - the possibly-null parameter value
 
 temporalType - the temporal-type to use in binding the date/time
 
 Returns:
 
 this, for method chaining
 - setParameter
```
NativeQuery<T> setParameter(int position,
 Object val,
 TemporalType temporalType)
```
 Description copied from interface: Query
 
 Bind a positional query parameter as some form of date/time using the indicated temporal-type.
 
 Parameters:
 
 position - the position of the parameter in the query string, numbered from 0.
 
 val - the possibly-null parameter value
 
 temporalType - the temporal-type to use in binding the date/time
 
 Returns:
 
 this, for method chaining
 - setParameter
```
 NativeQuery<T> setParameter(QueryParameter parameter,
 P val,
 TemporalType temporalType)
```
 Description copied from interface: Query
 
 Bind a query parameter as some form of date/time using the indicated temporal-type.
 
 Parameters:
 
 parameter - The query parameter memento
 
 val - the possibly-null parameter value
 
 temporalType - the temporal-type to use in binding the date/time
 
 Returns:
 
 this, for method chaining
 - setParameter
```
NativeQuery<T> setParameter(Parameter<Calendar> param,
 Calendar value,
 TemporalType temporalType)
```
 Specified by:
 
 setParameter in interface Query
 
 Specified by:
 
 setParameter in interface TypedQuery<T>
 - setParameter
```
NativeQuery<T> setParameter(Parameter<Date> param,
 Date value,
 TemporalType temporalType)
```
 Specified by:
 
 setParameter in interface Query
 
 Specified by:
 
 setParameter in interface TypedQuery<T>
 - setParameter
```
NativeQuery<T> setParameter(String name,
 Calendar value,
 TemporalType temporalType)
```
 Specified by:
 
 setParameter in interface Query
 
 Specified by:
 
 setParameter in interface TypedQuery<T>
 - setParameter
```
NativeQuery<T> setParameter(int position,
 Calendar value,
 TemporalType temporalType)
```
 Specified by:
 
 setParameter in interface Query
 
 Specified by:
 
 setParameter in interface TypedQuery<T>
 - setParameter
```
NativeQuery<T> setParameter(String name,
 Date value,
 TemporalType temporalType)
```
 Specified by:
 
 setParameter in interface Query
 
 Specified by:
 
 setParameter in interface TypedQuery<T>
 - setParameter
```
NativeQuery<T> setParameter(int position,
 Date value,
 TemporalType temporalType)
```
 Specified by:
 
 setParameter in interface Query
 
 Specified by:
 
 setParameter in interface TypedQuery<T>
 - setParameterList
```
 NativeQuery<T> setParameterList(QueryParameter parameter,
 Collection values)
```
 Description copied from interface: Query
 
 Bind multiple values to a query parameter using its inferred Type. The Hibernate type of the parameter values is first detected via the usage/position in the query and if not sufficient secondly guessed from the class of the first object in the collection. This is useful for binding a list of values to an expression such as foo.bar in (:value_list).
 
 Parameters:
 
 parameter - the parameter memento
 
 values - a collection of values to list
 
 Returns:
 
 this, for method chaining
 - setParameterList
```
NativeQuery<T> setParameterList(String name,
 Collection values)
```
 Description copied from interface: Query
 
 Bind multiple values to a named query parameter. The Hibernate type of the parameter is first detected via the usage/position in the query and if not sufficient secondly guessed from the class of the first object in the collection. This is useful for binding a list of values to an expression such as foo.bar in (:value_list).
 
 Parameters:
 
 name - the name of the parameter
 
 values - a collection of values to list
 
 Returns:
 
 this, for method chaining
 - setParameterList
```
NativeQuery<T> setParameterList(String name,
 Collection values,
 AllowableParameterType type)
```
 Description copied from interface: Query
 
 Bind multiple values to a named query parameter. This is useful for binding a list of values to an expression such as foo.bar in (:value_list).
 
 Parameters:
 
 name - the name of the parameter
 
 values - a collection of values to list
 
 type - the Hibernate allowable parameter type of the values
 
 Returns:
 
 this, for method chaining
 - setParameterList
```
NativeQuery<T> setParameterList(String name,
 Object[] values,
 AllowableParameterType type)
```
 Description copied from interface: Query
 
 Bind multiple values to a named query parameter. This is useful for binding a list of values to an expression such as foo.bar in (:value_list).
 
 Parameters:
 
 name - the name of the parameter
 
 values - a collection of values to list
 
 type - the Hibernate type of the values
 
 Returns:
 
 this, for method chaining
 - setParameterList
```
NativeQuery<T> setParameterList(String name,
 Object[] values)
```
 Description copied from interface: Query
 
 Bind multiple values to a named query parameter. The Hibernate type of the parameter is first detected via the usage/position in the query and if not sufficient secondly guessed from the class of the first object in the array. This is useful for binding a list of values to an expression such as foo.bar in (:value_list).
 
 Parameters:
 
 name - the name of the parameter
 
 values - a collection of values to list
 
 Returns:
 
 this, for method chaining
 - setParameter
```
NativeQuery<T> setParameter(String name,
 Object val,
 AllowableParameterType type)
```
 Description copied from interface: Query
 
 Bind a named query parameter using the supplied Type
 
 Parameters:
 
 name - the name of the parameter
 
 val - the possibly-null parameter value
 
 type - the Hibernate allowable parameter type
 
 Returns:
 
 this, for method chaining
 - setParameter
```
NativeQuery<T> setParameter(int position,
 Object val,
 AllowableParameterType type)
```
 Description copied from interface: Query
 
 Bind a value to a JDBC-style query parameter.
 
 Parameters:
 
 position - the position of the parameter in the query string, numbered from 0.
 
 val - the possibly-null parameter value
 
 type - the Hibernate allowable parameter type
 
 Returns:
 
 this, for method chaining
 - setParameter
```
 NativeQuery<T> setParameter(QueryParameter parameter,
 P val,
 AllowableParameterType type)
```
 Description copied from interface: Query
 
 Bind a query parameter using the supplied Type
 
 Parameters:
 
 parameter - The query parameter memento
 
 val - the possibly-null parameter value
 
 type - the Hibernate allowable parameter type
 
 Returns:
 
 this, for method chaining
 - setParameterList
```
NativeQuery<T> setParameterList(int position,
 Collection values)
```
 Description copied from interface: Query
 
 Bind multiple values to a positional query parameter. The Hibernate type of the parameter is first detected via the usage/position in the query and if not sufficient secondly guessed from the class of the first object in the collection. This is useful for binding a list of values to an expression such as foo.bar in (:value_list).
 
 Parameters:
 
 position - the parameter positional label
 
 values - a collection of values to list
 
 Returns:
 
 this, for method chaining
 - setParameterList
```
NativeQuery<T> setParameterList(String name,
 Collection values,
 Class type)
```
 Description copied from interface: Query
 
 Bind multiple values to a named query parameter. The Hibernate type of the parameter is first detected via the usage/position in the query and if not sufficient secondly guessed from the class of the first object in the collection. This is useful for binding a list of values to an expression such as foo.bar in (:value_list).
 
 Parameters:
 
 name - the name of the parameter
 
 values - a collection of values to list
 
 Returns:
 
 this, for method chaining
 - setParameterList
```
NativeQuery<T> setParameterList(int position,
 Collection values,
 Class type)
```
 Description copied from interface: Query
 
 Bind multiple values to a positional query parameter. The Hibernate type of the parameter is first detected via the usage/position in the query and if not sufficient secondly guessed from the class of the first object in the collection. This is useful for binding a list of values to an expression such as foo.bar in (:value_list).
 
 Parameters:
 
 position - the parameter positional label
 
 values - a collection of values to list
 
 Returns:
 
 this, for method chaining
 - setParameterList
```
NativeQuery<T> setParameterList(int position,
 Collection values,
 AllowableParameterType type)
```
 Description copied from interface: Query
 
 Bind multiple values to a positional query parameter. This is useful for binding a list of values to an expression such as foo.bar in (?1).
 
 Parameters:
 
 position - the parameter positional label
 
 values - a collection of values to list
 
 type - the Hibernate allowable parameter type of the values
 
 Returns:
 
 this, for method chaining
 - setParameterList
```
NativeQuery<T> setParameterList(int position,
 Object[] values,
 AllowableParameterType type)
```
 Description copied from interface: Query
 
 Bind multiple values to a named query parameter. This is useful for binding a list of values to an expression such as foo.bar in (:value_list).
 
 Parameters:
 
 position - the parameter positional label
 
 values - a collection of values to list
 
 type - the Hibernate type of the values
 
 Returns:
 
 this, for method chaining
 - setParameterList
```
NativeQuery<T> setParameterList(int position,
 Object[] values)
```
 Description copied from interface: Query
 
 Bind multiple values to a named query parameter. The Hibernate type of the parameter is first detected via the usage/position in the query and if not sufficient secondly guessed from the class of the first object in the array. This is useful for binding a list of values to an expression such as foo.bar in (:value_list).
 
 Parameters:
 
 position - the parameter positional label
 
 values - a collection of values to list
 
 Returns:
 
 this, for method chaining
 - setProperties
```
NativeQuery<T> setProperties(Object bean)
```
 Description copied from interface: Query
 
 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.
 
 Parameters:
 
 bean - any JavaBean or POJO
 
 Returns:
 
 this, for method chaining
 - setProperties
```
NativeQuery<T> setProperties(Map bean)
```
 Description copied from interface: Query
 
 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.
 
 Parameters:
 
 bean - a java.util.Map
 
 Returns:
 
 this, for method chaining

Interface NativeQuery<T>

Nested Class Summary

Method Summary

Methods inherited from interface org.hibernate.query.Query

Methods inherited from interface javax.persistence.TypedQuery

Methods inherited from interface javax.persistence.Query

Methods inherited from interface org.hibernate.query.CommonQueryContract

Methods inherited from interface org.hibernate.query.SynchronizeableQuery

Method Detail

addScalar

addScalar

addScalar

addScalar

addScalar

addScalar

addScalar

addInstantiation

addAttributeResult

addAttributeResult

addAttributeResult

addRoot

addRoot

addEntity

addEntity

addEntity

addEntity

addEntity

addEntity

addFetch

addJoin

addJoin

addJoin

addSynchronizedQuerySpace

addSynchronizedEntityName

addSynchronizedEntityClass

setHibernateFlushMode

setFlushMode

setCacheMode

setCacheable

setCacheRegion

setTimeout

setFetchSize

setReadOnly

setLockOptions

setLockMode

setComment

addQueryHint

setMaxResults

setFirstResult

setHint

setLockMode

setTupleTransformer

setResultListTransformer

setResultTransformer

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameterList