Package org.hibernate.query.criteria

@Incubating package org.hibernate.query.criteria

The JPA-standard criteria query API defines all the operations needed express any query written in standard JPQL. This package extends the JPA-defined API, allowing any query written in HQL to be expressed via the criteria API.

The gateway to this functionality is HibernateCriteriaBuilder, which extends CriteriaBuilder.

Types defined in this package extend the equivalent types in jakarta.persistence.criteria with additional operations. For example, JpaCriteriaQuery adds the methods:

• JpaSelectCriteria.from(Subquery), which allows the use of a subquery in the from clause of the query, and
• JpaCteContainer.with(AbstractQuery), which allows the creation of common table expressions.

The very useful operation HibernateCriteriaBuilder.createQuery(java.lang.String, java.lang.Class) transforms a given HQL query string to an equivalent criteria query.

The class CriteriaDefinition is a helpful utility that makes it easier to construct criteria queries.

See Also:

• HibernateCriteriaBuilder
• JpaCriteriaQuery
• JpaCriteriaUpdate
• JpaCriteriaDelete
• JpaCriteriaInsertValues
• JpaCriteriaInsertSelect
• JpaCteCriteria
• JpaSubQuery
• JpaExpression
• HibernateCriteriaBuilder.createQuery(java.lang.String, java.lang.Class)
• CriteriaDefinition

Related Packages

Package	Description
org.hibernate.query	Everything related to HQL/JPQL, native SQL, and criteria queries.
org.hibernate.query.criteria.internal
org.hibernate.query.criteria.spi	SPI for extending HibernateCriteriaBuilder with additional functionality by registering a Service.

Class	Description
CriteriaDefinition<R>	A utility class that makes it easier to build criteria queries.
HibernateCriteriaBuilder	A JPA CriteriaBuilder is a source of objects which may be composed to express a criteria query.
JpaCastTarget<T>	The target for cast.
JpaCoalesce<T>
JpaCollectionJoin<O,T>	Specialization of JpaJoin for Collection typed attribute joins
JpaCompoundSelection<T>
JpaConflictClause<T>	A conflict clause for insert statements.
JpaConflictUpdateAction<T>	The update action that should happen on a unique constraint violation for an insert statement.
JpaCriteriaBase
JpaCriteriaDelete<T>
JpaCriteriaInsert<T>	The commonalities between insert-select and insert-values.
JpaCriteriaInsertSelect<T>	A representation of SqmInsertSelectStatement at the org.hibernate.query.criteria level, even though JPA does not define support for insert-select criteria.
JpaCriteriaInsertValues<T>	A representation of SqmInsertValuesStatement at the org.hibernate.query.criteria level, even though JPA does not define support for insert-values criteria.
JpaCriteriaNode	Base contract for nodes making up the criteria tree
JpaCriteriaQuery<T>	Extension of the JPA CriteriaQuery
JpaCriteriaSelect<T>	Extension of the JPA CriteriaSelect.
JpaCriteriaUpdate<T>
JpaCrossJoin<T>
JpaCteContainer	Common contract for criteria parts that can hold CTEs (common table expressions).
JpaCteCriteria<T>	A CTE (common table expression) criteria.
JpaCteCriteriaAttribute	Describes the attribute of a JpaCteCriteriaType.
JpaCteCriteriaType<T>	A CTE (common table expression) criteria type.
JpaDerivedFrom<T>
JpaDerivedJoin<T>
JpaDerivedRoot<T>
JpaEntityJoin<L,R>
JpaExpression<T>	API extension to the JPA Expression contract
JpaFetch<O,T>
JpaFetchParent<O,T>
JpaFrom<O,T>	API extension to the JPA From contract
JpaFunction<T>	Contract for expressions which model a SQL function call.
JpaFunctionFrom<O,T>
JpaFunctionJoin<E>
JpaFunctionRoot<E>
JpaInPredicate<T>
JpaJoin<L,R>	Consolidates the Join and Fetch hierarchies since that is how we implement them.
JpaJsonExistsExpression	A special expression for the json_exists function.
JpaJsonExistsNode	The base for json_exists function nodes.
JpaJsonExistsNode.ErrorBehavior	The behavior of the json exists expression when a JSON processing error occurs.
JpaJsonQueryExpression	A special expression for the json_query function.
JpaJsonQueryNode	The base for json_query function nodes.
JpaJsonQueryNode.EmptyBehavior	The behavior of the json query expression when a JSON path does not resolve for a JSON document.
JpaJsonQueryNode.ErrorBehavior	The behavior of the json query expression when a JSON processing error occurs.
JpaJsonQueryNode.WrapMode	The kind of wrapping to apply to the results of the query.
JpaJsonTableColumnsNode	A special expression for the definition of columns within the json_table function.
JpaJsonTableFunction	A special expression for the json_table function.
JpaJsonTableFunction.ErrorBehavior	The behavior of the json exists expression when a JSON processing error occurs.
JpaJsonValueExpression<T>	A special expression for the json_value function.
JpaJsonValueNode<T>	The base for json_value function nodes.
JpaJsonValueNode.EmptyBehavior	The behavior of the json value expression when a JSON path does not resolve for a JSON document.
JpaJsonValueNode.ErrorBehavior	The behavior of the json value expression when a JSON processing error occurs.
JpaListJoin<O,T>	Specialization of JpaJoin for List typed attribute joins
JpaManipulationCriteria<E>
JpaMapJoin<O,K,V>	Specialization of JpaJoin for Map typed attribute joins
JpaOrder
JpaParameterExpression<T>
JpaPath<T>	API extension to the JPA Path contract
JpaPluralJoin<O,C,E>	Specialization of JpaJoin for Set typed attribute joins
JpaPredicate
JpaQueryableCriteria<T>	Common contract for the forms of criteria that are "queryable" - can be converted into a Query.
JpaQueryGroup<T>	A query group i.e.
JpaQueryPart<T>	Models a query part i.e.
JpaQueryStructure<T>	Models a SELECT query.
JpaRoot<T>
JpaSearchedCase<T>
JpaSearchOrder	Represents the search order for a recursive CTE (common table expression).
JpaSelectCriteria<T>	Commonality between a JPA JpaCriteriaQuery and JpaSubQuery, mainly in the form of delegation to JpaQueryStructure
JpaSelection<T>	API extension to the JPA Selection contract
JpaSetJoin<O,T>	Specialization of JpaJoin for Set typed attribute joins
JpaSetReturningFunction<T>	A set returning function criteria.
JpaSimpleCase<C,R>
JpaSubQuery<T>
JpaTreatedFrom<L,R,R1 extends R>
JpaTreatedJoin<L,R,R1 extends R>
JpaTreatedPath<T,S extends T>
JpaTupleElement<T>	API extension to the JPA TupleElement contract
JpaValues	A tuple of values.
JpaWindow	Common contract for window parts used in window and aggregate functions.
JpaWindowFrame	Common contract for a JpaWindow frame specification.
JpaXmlElementExpression	A special expression for the xmlelement function.
JpaXmlTableColumnNode<T>	A special node for column defined for a xmltable function.
JpaXmlTableFunction	A special expression for the xmltable function.
ValueHandlingMode	This enum defines how values passed to JPA Criteria API are handled.