Package org.hibernate.reactive.stage

Interface Stage.QueryProducer

All Superinterfaces:

Stage.Closeable

All Known Subinterfaces:

Stage.Session, Stage.StatelessSession

Enclosing interface:

Stage

public static sealed interface Stage.QueryProducer
extends Stage.Closeable
permits Stage.Session, Stage.StatelessSession

Operations common to objects which act as factories for instances of Stage.Query. This is a common supertype of Stage.Session and Stage.StatelessSession.

Since:

3.0

Method Summary

Modifier and Type	Method	Description
<T> EntityGraph<T>	createEntityGraph(Class<T> rootType)	Create a new mutable EntityGraph
<T> EntityGraph<T>	createEntityGraph(Class<T> rootType, String graphName)	Create a new mutable copy of a named EntityGraph
Stage.MutationQuery	createMutationQuery(CriteriaDelete<?> deleteQuery)	Create an instance of Stage.MutationQuery for the given delete tree.
Stage.MutationQuery	createMutationQuery(CriteriaUpdate<?> updateQuery)	Create an instance of Stage.MutationQuery for the given update tree.
Stage.MutationQuery	createMutationQuery(String queryString)	Create an instance of Stage.MutationQuery for the given HQL/JPQL update or delete statement.
Stage.MutationQuery	createMutationQuery(JpaCriteriaInsert<?> insert)	Create a Stage.MutationQuery from the given insert select criteria tree
<R> Stage.Query<R>	createNamedQuery(String queryName)	Create an instance of Stage.Query for the named query.
<R> Stage.SelectionQuery<R>	createNamedQuery(String queryName, Class<R> resultType)	Create an instance of Stage.SelectionQuery for the named query.
Stage.MutationQuery	createNativeMutationQuery(String sqlString)	Create an instance of Stage.MutationQuery for the given native SQL update, insert, or delete statement.
<R> Stage.Query<R>	createNativeQuery(String queryString)	Create an instance of Stage.Query for the given SQL query string, or SQL update, insert, or delete statement.
<R> Stage.SelectionQuery<R>	createNativeQuery(String queryString, Class<R> resultType)	Create an instance of Stage.Query for the given SQL query string, using the given resultType to interpret the results.
<R> Stage.SelectionQuery<R>	createNativeQuery(String queryString, Class<R> resultType, AffectedEntities affectedEntities)	Create an instance of Stage.SelectionQuery for the given SQL query string, using the given resultType to interpret the results.
<R> Stage.Query<R>	createNativeQuery(String queryString, AffectedEntities affectedEntities)	Create an instance of Stage.Query for the given SQL query string, or SQL update, insert, or delete statement.
<R> Stage.SelectionQuery<R>	createNativeQuery(String queryString, ResultSetMapping<R> resultSetMapping)	Create an instance of Stage.SelectionQuery for the given SQL query string, using the given ResultSetMapping to interpret the result set.
<R> Stage.SelectionQuery<R>	createNativeQuery(String queryString, ResultSetMapping<R> resultSetMapping, AffectedEntities affectedEntities)	Create an instance of Stage.SelectionQuery for the given SQL query string, using the given ResultSetMapping to interpret the result set.
<R> Stage.MutationQuery	createQuery(CriteriaDelete<R> criteriaDelete)	Create an instance of Stage.MutationQuery for the given criteria delete.
<R> Stage.SelectionQuery<R>	createQuery(CriteriaQuery<R> criteriaQuery)	Create an instance of Stage.SelectionQuery for the given criteria query.
<R> Stage.MutationQuery	createQuery(CriteriaUpdate<R> criteriaUpdate)	Create an instance of Stage.MutationQuery for the given criteria update.
<R> Stage.Query<R>	createQuery(TypedQueryReference<R> typedQueryReference)	Create a typed Stage.Query instance for the given typed query reference.
<R> Stage.Query<R>	createQuery(String queryString)	Deprecated. See explanation in QueryProducer.createSelectionQuery(String)
<R> Stage.SelectionQuery<R>	createQuery(String queryString, Class<R> resultType)	Create an instance of Stage.SelectionQuery for the given HQL/JPQL query string and query result type.
<R> Stage.SelectionQuery<R>	createSelectionQuery(String queryString, Class<R> resultType)	Create an instance of Stage.SelectionQuery for the given HQL/JPQL query string.
CriteriaBuilder	getCriteriaBuilder()	Convenience method to obtain the CriteriaBuilder.
<T> EntityGraph<T>	getEntityGraph(Class<T> rootType, String graphName)	Obtain a named EntityGraph
<T> ResultSetMapping<T>	getResultSetMapping(Class<T> resultType, String mappingName)	Obtain a native SQL result set mapping defined via the annotation SqlResultSetMapping.

Methods inherited from interface org.hibernate.reactive.stage.Stage.Closeable

close, isOpen

Method Details

createSelectionQuery

<R> Stage.SelectionQuery<R> createSelectionQuery(String queryString,
 Class<R> resultType)

Create an instance of Stage.SelectionQuery for the given HQL/JPQL query string.

Parameters:

queryString - The HQL/JPQL query

Returns:

The Stage.SelectionQuery instance for manipulation and execution

See Also:

• EntityManager.createQuery(String, Class)

createMutationQuery

Stage.MutationQuery createMutationQuery(String queryString)

Create an instance of Stage.MutationQuery for the given HQL/JPQL update or delete statement.

Parameters:

queryString - The HQL/JPQL query, update or delete statement

Returns:

The Stage.MutationQuery instance for manipulation and execution

See Also:

• EntityManager.createQuery(String)

createMutationQuery

Stage.MutationQuery createMutationQuery(CriteriaUpdate<?> updateQuery)

Create an instance of Stage.MutationQuery for the given update tree.

Parameters:

updateQuery - the update criteria query

Returns:

The Stage.MutationQuery instance for manipulation and execution

See Also:

• QueryProducer.createMutationQuery(CriteriaUpdate)

createMutationQuery

Stage.MutationQuery createMutationQuery(CriteriaDelete<?> deleteQuery)

Create an instance of Stage.MutationQuery for the given delete tree.

Parameters:

deleteQuery - the delete criteria query

Returns:

The Stage.MutationQuery instance for manipulation and execution

See Also:

• QueryProducer.createMutationQuery(CriteriaDelete)

createMutationQuery

Stage.MutationQuery createMutationQuery(JpaCriteriaInsert<?> insert)

Create a Stage.MutationQuery from the given insert select criteria tree

Parameters:

insert - the insert select criteria query

Returns:

The Stage.MutationQuery instance for manipulation and execution

See Also:

• QueryProducer.createMutationQuery(JpaCriteriaInsert)

createNativeMutationQuery

Stage.MutationQuery createNativeMutationQuery(String sqlString)

Create an instance of Stage.MutationQuery for the given native SQL update, insert, or delete statement.

Parameters:

sqlString - a native SQL statement string

Returns:

The Stage.MutationQuery instance for manipulation and execution

See Also:

• QueryProducer.createNativeMutationQuery(String)

createQuery

<R> Stage.Query<R> createQuery(TypedQueryReference<R> typedQueryReference)

Create a typed Stage.Query instance for the given typed query reference.

Parameters:

typedQueryReference - the type query reference

Returns:

The Stage.Query instance for execution

Throws:

IllegalArgumentException - if a query has not been defined with the name of the typed query reference or if the query result is found to not be assignable to result class of the typed query reference

See Also:

• QueryProducer.createQuery(TypedQueryReference)

createQuery

@Deprecated
<R> Stage.Query<R> createQuery(String queryString)

Deprecated.

See explanation in QueryProducer.createSelectionQuery(String)

Create an instance of Stage.Query for the given HQL/JPQL query string or HQL/JPQL update or delete statement. In the case of an update or delete, the returned Stage.Query must be executed using Stage.MutationQuery.executeUpdate() which returns an affected row count.

Parameters:

queryString - The HQL/JPQL query, update or delete statement

Returns:

The Stage.Query instance for manipulation and execution

See Also:

• EntityManager.createQuery(String)

createQuery

<R> Stage.SelectionQuery<R> createQuery(String queryString,
 Class<R> resultType)

Create an instance of Stage.SelectionQuery for the given HQL/JPQL query string and query result type.

Parameters:

queryString - The HQL/JPQL query

resultType - the Java type returned in each row of query results

Returns:

The Stage.Query instance for manipulation and execution

See Also:

• EntityManager.createQuery(String, Class)

createQuery

<R> Stage.MutationQuery createQuery(CriteriaUpdate<R> criteriaUpdate)

Create an instance of Stage.MutationQuery for the given criteria update.

Parameters:

criteriaUpdate - The CriteriaUpdate

Returns:

The Stage.MutationQuery instance for manipulation and execution

createQuery

<R> Stage.MutationQuery createQuery(CriteriaDelete<R> criteriaDelete)

Create an instance of Stage.MutationQuery for the given criteria delete.

Parameters:

criteriaDelete - The CriteriaDelete

Returns:

The Stage.MutationQuery instance for manipulation and execution

createNamedQuery

<R> Stage.Query<R> createNamedQuery(String queryName)

Create an instance of Stage.Query for the named query.

Parameters:

queryName - The name of the query

Returns:

The Stage.Query instance for manipulation and execution

See Also:

• EntityManager.createQuery(String)

createNamedQuery

<R> Stage.SelectionQuery<R> createNamedQuery(String queryName,
 Class<R> resultType)

Create an instance of Stage.SelectionQuery for the named query.

Parameters:

queryName - The name of the query

resultType - the Java type returned in each row of query results

Returns:

The Stage.SelectionQuery instance for manipulation and execution

See Also:

• EntityManager.createQuery(String, Class)

createNativeQuery

<R> Stage.SelectionQuery<R> createNativeQuery(String queryString,
 Class<R> resultType)

Create an instance of Stage.Query for the given SQL query string, using the given resultType to interpret the results.

• If the given result type is Object, or a built-in type such as String or Integer, the result set must have a single column, which will be returned as a scalar.
• If the given result type is Object[], then the result set must have multiple columns, which will be returned as elements of arrays of type Object[].
• Otherwise, the given result type must be an entity class, in which case the result set column aliases must map to the fields of the entity, and the query will return instances of the entity.

Parameters:

queryString - The SQL query

resultType - the Java type returned in each row of query results

Returns:

The Stage.SelectionQuery instance for manipulation and execution

See Also:

• EntityManager.createNativeQuery(String, Class)

createNativeQuery

<R> Stage.SelectionQuery<R> createNativeQuery(String queryString,
 Class<R> resultType,
 AffectedEntities affectedEntities)

Create an instance of Stage.SelectionQuery for the given SQL query string, using the given resultType to interpret the results.

• If the given result type is Object, or a built-in type such as String or Integer, the result set must have a single column, which will be returned as a scalar.
• If the given result type is Object[], then the result set must have multiple columns, which will be returned as elements of arrays of type Object[].
• Otherwise, the given result type must be an entity class, in which case the result set column aliases must map to the fields of the entity, and the query will return instances of the entity.

Any affected entities are synchronized with the database before execution of the query.

Parameters:

queryString - The SQL query

resultType - the Java type returned in each row of query results

affectedEntities - The entities which are affected by the query

Returns:

The Stage.Query instance for manipulation and execution

See Also:

• EntityManager.createNativeQuery(String, Class)

createNativeQuery

<R> Stage.SelectionQuery<R> createNativeQuery(String queryString,
 ResultSetMapping<R> resultSetMapping)

Create an instance of Stage.SelectionQuery for the given SQL query string, using the given ResultSetMapping to interpret the result set.

Parameters:

queryString - The SQL query

resultSetMapping - the result set mapping

Returns:

The Stage.Query instance for manipulation and execution

See Also:

• getResultSetMapping(Class, String)
• EntityManager.createNativeQuery(String, String)

createNativeQuery

<R> Stage.SelectionQuery<R> createNativeQuery(String queryString,
 ResultSetMapping<R> resultSetMapping,
 AffectedEntities affectedEntities)

Create an instance of Stage.SelectionQuery for the given SQL query string, using the given ResultSetMapping to interpret the result set.

Any affected entities are synchronized with the database before execution of the query.

Parameters:

queryString - The SQL query

resultSetMapping - the result set mapping

affectedEntities - The entities which are affected by the query

Returns:

The Stage.Query instance for manipulation and execution

See Also:

• getResultSetMapping(Class, String)
• EntityManager.createNativeQuery(String, String)

createNativeQuery

<R> Stage.Query<R> createNativeQuery(String queryString)

Create an instance of Stage.Query for the given SQL query string, or SQL update, insert, or delete statement. In the case of an update, insert, or delete, the returned Stage.Query must be executed using Stage.MutationQuery.executeUpdate() which returns an affected row count. In the case of a query:

• If the result set has a single column, the results will be returned as scalars.
• Otherwise, if the result set has multiple columns, the results will be returned as elements of arrays of type Object[].

Parameters:

queryString - The SQL select, update, insert, or delete statement

createNativeQuery

<R> Stage.Query<R> createNativeQuery(String queryString,
 AffectedEntities affectedEntities)

Create an instance of Stage.Query for the given SQL query string, or SQL update, insert, or delete statement. In the case of an update, insert, or delete, the returned Stage.Query must be executed using Stage.MutationQuery.executeUpdate() which returns an affected row count. In the case of a query:

• If the result set has a single column, the results will be returned as scalars.
• Otherwise, if the result set has multiple columns, the results will be returned as elements of arrays of type Object[].

Any affected entities are synchronized with the database before execution of the statement.

Parameters:

queryString - The SQL select, update, insert, or delete statement

affectedEntities - The entities which are affected by the statement

createQuery

<R> Stage.SelectionQuery<R> createQuery(CriteriaQuery<R> criteriaQuery)

Create an instance of Stage.SelectionQuery for the given criteria query.

Parameters:

criteriaQuery - The CriteriaQuery

Returns:

The Stage.SelectionQuery instance for manipulation and execution

See Also:

• EntityManager.createQuery(String)

getResultSetMapping

<T> ResultSetMapping<T> getResultSetMapping(Class<T> resultType,
 String mappingName)

Obtain a native SQL result set mapping defined via the annotation SqlResultSetMapping.

getEntityGraph

<T> EntityGraph<T> getEntityGraph(Class<T> rootType,
 String graphName)

Obtain a named EntityGraph

createEntityGraph

<T> EntityGraph<T> createEntityGraph(Class<T> rootType)

Create a new mutable EntityGraph

createEntityGraph

<T> EntityGraph<T> createEntityGraph(Class<T> rootType,
 String graphName)

Create a new mutable copy of a named EntityGraph

getCriteriaBuilder

CriteriaBuilder getCriteriaBuilder()

Convenience method to obtain the CriteriaBuilder.

Since:

3