Package org.hibernate.query

Interface QueryProducer

All Known Subinterfaces:

EventSource, QueryProducerImplementor, Session, SessionImplementor, SharedSessionContract, SharedSessionContractImplementor, StatelessSession

All Known Implementing Classes:

AbstractDelegateSessionImplementor, AbstractSharedSessionContract, SessionDelegatorBaseImpl, SessionImpl, SessionLazyDelegator, SharedSessionDelegatorBaseImpl, StatelessSessionImpl, ToOneDelegateSessionImplementor

public interface QueryProducer

Contract for things that can produce instances of Query and NativeQuery. Implementors include Session and StatelessSession. Many operations of the interface have the same or very similar signatures to operations of EntityManager. They are declared here to allow reuse by StatelessSession.

Unlike the corresponding operations of EntityManager, operations for creating untyped instances of Query are all marked as deprecated. Clients must migrate to the use of the equivalent operations which accept a Class and return a typed Query.

Method Summary

Modifier and Type	Method	Description
MutationQuery	createMutationQuery(jakarta.persistence.criteria.CriteriaDelete deleteQuery)	Create a MutationQuery from the given delete criteria tree
MutationQuery	createMutationQuery(jakarta.persistence.criteria.CriteriaUpdate updateQuery)	Create a MutationQuery from the given update criteria tree
MutationQuery	createMutationQuery(String hqlString)	Create a MutationQuery reference for the given HQL insert, update, or delete statement.
MutationQuery	createMutationQuery(JpaCriteriaInsertSelect insertSelect)	Create a MutationQuery from the given insert-select criteria tree
MutationQuery	createNamedMutationQuery(String name)	Create a MutationQuery instance for the given named insert, update, or delete HQL query.
Query	createNamedQuery(String name)	Deprecated. use createNamedQuery(String, Class) or createNamedMutationQuery(String)
<R> Query<R>	createNamedQuery(String name, Class<R> resultClass)	Create a typed Query instance for the given named query.
SelectionQuery<?>	createNamedSelectionQuery(String name)	Create a SelectionQuery instance for the named NamedQuery
<R> SelectionQuery<R>	createNamedSelectionQuery(String name, Class<R> resultType)	Create a SelectionQuery instance for the named NamedQuery with the expected result-type
MutationQuery	createNativeMutationQuery(String sqlString)	Create a NativeQuery instance for the given native SQL statement.
NativeQuery	createNativeQuery(String sqlString)	Deprecated. use createNativeQuery(String, Class)
<R> NativeQuery<R>	createNativeQuery(String sqlString, Class<R> resultClass)	Create a NativeQuery instance for the given native SQL query using implicit mapping to the specified Java type.
<R> NativeQuery<R>	createNativeQuery(String sqlString, Class<R> resultClass, String tableAlias)	Create a NativeQuery instance for the given native SQL query using implicit mapping to the specified Java type.
NativeQuery	createNativeQuery(String sqlString, String resultSetMappingName)	Deprecated. use createNativeQuery(String, String, Class)
<R> NativeQuery<R>	createNativeQuery(String sqlString, String resultSetMappingName, Class<R> resultClass)	Create a NativeQuery instance for the given native SQL query using an explicit mapping to the specified Java type.
Query	createQuery(jakarta.persistence.criteria.CriteriaDelete deleteQuery)	Deprecated. use createMutationQuery(CriteriaDelete)
<R> Query<R>	createQuery(jakarta.persistence.criteria.CriteriaQuery<R> criteriaQuery)	Create a Query for the given JPA CriteriaQuery.
Query	createQuery(jakarta.persistence.criteria.CriteriaUpdate updateQuery)	Deprecated. use createMutationQuery(CriteriaUpdate)
Query	createQuery(String queryString)	Deprecated. use createQuery(String, Class), createSelectionQuery(java.lang.String) or createMutationQuery(String) depending on intention
<R> Query<R>	createQuery(String queryString, Class<R> resultClass)	Create a typed Query instance for the given HQL query string.
<R> SelectionQuery<R>	createSelectionQuery(jakarta.persistence.criteria.CriteriaQuery<R> criteria)	Create a SelectionQuery reference for the given Criteria.
SelectionQuery<?>	createSelectionQuery(String hqlString)	Create a SelectionQuery reference for the given HQL.
<R> SelectionQuery<R>	createSelectionQuery(String hqlString, Class<R> resultType)	Create a SelectionQuery reference for the given HQL.
NativeQuery	getNamedNativeQuery(String name)	Deprecated. use createNamedQuery(String, Class)
NativeQuery	getNamedNativeQuery(String name, String resultSetMapping)	Deprecated. use createNamedQuery(String, Class)
Query	getNamedQuery(String queryName)	Deprecated. use createNamedQuery(String, Class)

Method Detail

createQuery

@Deprecated(since="6.0")
Query createQuery(String queryString)

Deprecated.

use createQuery(String, Class), createSelectionQuery(java.lang.String) or createMutationQuery(String) depending on intention

Create a Query instance for the given HQL query, or HQL insert, update, or delete statement.

Parameters:

queryString - The HQL query

Returns:

The Query instance for manipulation and execution

See Also:

EntityManager.createQuery(String)

createQuery

<R> Query<R> createQuery(String queryString,
                         Class<R> resultClass)

Create a typed Query instance for the given HQL query string.

The returned Query may be executed by calling Query.getResultList() or Query.getSingleResult().

Parameters:

queryString - The HQL query

resultClass - The type of the query result

Returns:

The Query instance for manipulation and execution

See Also:

EntityManager.createQuery(String,Class)

createQuery

<R> Query<R> createQuery(jakarta.persistence.criteria.CriteriaQuery<R> criteriaQuery)

Create a Query for the given JPA CriteriaQuery.

createQuery

@Deprecated(since="6.0")
Query createQuery(jakarta.persistence.criteria.CriteriaUpdate updateQuery)

Deprecated.

use createMutationQuery(CriteriaUpdate)

Create a MutationQuery for the given JPA CriteriaUpdate

createQuery

@Deprecated(since="6.0")
Query createQuery(jakarta.persistence.criteria.CriteriaDelete deleteQuery)

Deprecated.

use createMutationQuery(CriteriaDelete)

Create a MutationQuery for the given JPA CriteriaDelete

createNativeQuery

@Deprecated(since="6.0")
NativeQuery createNativeQuery(String sqlString)

Deprecated.

use createNativeQuery(String, Class)

Create a NativeQuery instance for the given native SQL query.

Parameters:

sqlString - a native SQL query string

Returns:

The NativeQuery instance for manipulation and execution

See Also:

EntityManager.createNativeQuery(String)

createNativeQuery

<R> NativeQuery<R> createNativeQuery(String sqlString,
                                     Class<R> resultClass)

Create a NativeQuery instance for the given native SQL query using implicit mapping to the specified Java type.

If the given class is an entity class, this method is equivalent to createNativeQuery(sqlString).addEntity("alias1", resultClass).

Parameters:

sqlString - The native (SQL) query string

resultClass - The Java entity type to map results to

Returns:

The NativeQuery instance for manipulation and execution

See Also:

EntityManager.createNativeQuery(String,Class)

createNativeQuery

<R> NativeQuery<R> createNativeQuery(String sqlString,
                                     Class<R> resultClass,
                                     String tableAlias)

Create a NativeQuery instance for the given native SQL query using implicit mapping to the specified Java type.

If the given class is an entity class, this method is equivalent to createNativeQuery(sqlString).addEntity(tableAlias, resultClass).

Parameters:

sqlString - Native (SQL) query string

resultClass - The Java entity type to map results to

tableAlias - The table alias for columns in the result set

Returns:

The NativeQuery instance for manipulation and execution

See Also:

EntityManager.createNativeQuery(String,Class)

createNativeQuery

@Deprecated(since="6.0")
NativeQuery createNativeQuery(String sqlString,
                              String resultSetMappingName)

Deprecated.

use createNativeQuery(String, String, Class)

Create a NativeQuery instance for the given native SQL query using an explicit mapping to the specified Java type.

The given result set mapping name must identify a mapping defined by a SqlResultSetMapping annotation.

Parameters:

sqlString - The native (SQL) query string

resultSetMappingName - The explicit result mapping name

Returns:

The NativeQuery instance for manipulation and execution

See Also:

EntityManager.createNativeQuery(String,Class), SqlResultSetMapping

createNativeQuery

<R> NativeQuery<R> createNativeQuery(String sqlString,
                                     String resultSetMappingName,
                                     Class<R> resultClass)

Create a NativeQuery instance for the given native SQL query using an explicit mapping to the specified Java type.

The given result set mapping name must identify a mapping defined by a SqlResultSetMapping annotation.

Parameters:

sqlString - The native (SQL) query string

resultSetMappingName - The explicit result mapping name

Returns:

The NativeQuery instance for manipulation and execution

See Also:

EntityManager.createNativeQuery(String,Class), SqlResultSetMapping

createSelectionQuery

SelectionQuery<?> createSelectionQuery(String hqlString)

Create a SelectionQuery reference for the given HQL. Only valid for select queries

Throws:

IllegalSelectQueryException - if the given HQL query is an insert, update or delete query

See Also:

EntityManager.createQuery(String)

createSelectionQuery

<R> SelectionQuery<R> createSelectionQuery(String hqlString,
                                           Class<R> resultType)

Create a SelectionQuery reference for the given HQL. Only valid for select queries

Throws:

IllegalSelectQueryException - if the given HQL query is an insert, update or delete query

See Also:

EntityManager.createQuery(String)

createSelectionQuery

<R> SelectionQuery<R> createSelectionQuery(jakarta.persistence.criteria.CriteriaQuery<R> criteria)

Create a SelectionQuery reference for the given Criteria.

See Also:

EntityManager.createQuery(CriteriaQuery)

createMutationQuery

MutationQuery createMutationQuery(String hqlString)

Create a MutationQuery reference for the given HQL insert, update, or delete statement.

Throws:

IllegalMutationQueryException - if the given HQL query is a select query

createMutationQuery

MutationQuery createMutationQuery(jakarta.persistence.criteria.CriteriaUpdate updateQuery)

Create a MutationQuery from the given update criteria tree

createMutationQuery

MutationQuery createMutationQuery(jakarta.persistence.criteria.CriteriaDelete deleteQuery)

Create a MutationQuery from the given delete criteria tree

createMutationQuery

MutationQuery createMutationQuery(JpaCriteriaInsertSelect insertSelect)

Create a MutationQuery from the given insert-select criteria tree

createNativeMutationQuery

MutationQuery createNativeMutationQuery(String sqlString)

Create a NativeQuery instance for the given native SQL statement.

Parameters:

sqlString - a native SQL statement string

Returns:

The NativeQuery instance for manipulation and execution

createNamedQuery

@Deprecated(since="6.0")
Query createNamedQuery(String name)

Deprecated.

use createNamedQuery(String, Class) or createNamedMutationQuery(String)

Create a typed Query instance for the given named query. The named query might be defined in HQL or in native SQL.

Parameters:

name - the name of a pre-defined, named query

Returns:

The Query instance for manipulation and execution

Throws:

IllegalArgumentException - if a query has not been defined with the given name or if the query string is found to be invalid

See Also:

EntityManager.createNamedQuery(String)

createNamedQuery

<R> Query<R> createNamedQuery(String name,
                              Class<R> resultClass)

Create a typed Query instance for the given named query. The named query might be defined in HQL or in native SQL.

Parameters:

name - the name of a query defined in metadata

resultClass - the type of the query result

Returns:

The Query instance for manipulation and execution

Throws:

IllegalArgumentException - if a query has not been defined with the given name or if the query string is found to be invalid or if the query result is found to not be assignable to the specified type

See Also:

EntityManager.createNamedQuery(String,Class)

createNamedSelectionQuery

SelectionQuery<?> createNamedSelectionQuery(String name)

Create a SelectionQuery instance for the named NamedQuery

Throws:

IllegalSelectQueryException - if the given HQL query is a select query

UnknownNamedQueryException - if no query has been defined with the given name

createNamedSelectionQuery

<R> SelectionQuery<R> createNamedSelectionQuery(String name,
                                                Class<R> resultType)

Create a SelectionQuery instance for the named NamedQuery with the expected result-type

Throws:

IllegalSelectQueryException - if the given HQL query is a select query

UnknownNamedQueryException - if no query has been defined with the given name

createNamedMutationQuery

MutationQuery createNamedMutationQuery(String name)

Create a MutationQuery instance for the given named insert, update, or delete HQL query. The named query might be defined as HQL) or native-SQL.

Throws:

IllegalMutationQueryException - if the given HQL query is a select query

UnknownNamedQueryException - if no query has been defined with the given name

getNamedQuery

@Deprecated(since="6.0")
Query getNamedQuery(String queryName)

Deprecated.

use createNamedQuery(String, Class)

Create a Query instance for the named query.

Parameters:

queryName - the name of a pre-defined, named query

Returns:

The Query instance for manipulation and execution

Throws:

IllegalArgumentException - if a query has not been defined with the given name or if the query string is found to be invalid

getNamedNativeQuery

@Deprecated(since="6.0")
NativeQuery getNamedNativeQuery(String name)

Deprecated.

use createNamedQuery(String, Class)

Get a NativeQuery instance for a named native SQL query

Parameters:

name - The name of the pre-defined query

Returns:

The NativeQuery instance for manipulation and execution

getNamedNativeQuery

@Deprecated(since="6.0")
NativeQuery getNamedNativeQuery(String name,
                                String resultSetMapping)

Deprecated.

use createNamedQuery(String, Class)

Get a NativeQuery instance for a named native SQL query

Parameters:

name - The name of the pre-defined query

Returns:

The NativeQuery instance for manipulation and execution