Package org.hibernate.query

package org.hibernate.query

Everything related to HQL/JPQL, native SQL, and criteria queries.

The important interfaces SelectionQuery, MutationQuery, Query, and NativeQuery provide an API for executing queries. Instances of these interfaces may be obtained from a QueryProducer, that is, from any Session or StatelessSession.

The classes Order, Page, KeyedPage, and KeyedResultList define an API for dynamic ordering and key-based pagination. These classes are especially useful as parameters of generated @Find and @HQL methods.

Hibernate's extensions to the JPA criteria query API are defined in the subpackage org.hibernate.query.criteria, with HibernateCriteriaBuilder as the entry point.

Other subpackages contain SPIs and internal implementation details, including the HQL parser and translator.

Related Packages

Package	Description
org.hibernate	This package defines the central Hibernate APIs, beginning with SessionFactory, which represents an instance of Hibernate at runtime and is the source of new instances of Session and StatelessSession, the most important APIs exposing persistence-related operations for entities.
org.hibernate.query.common	Common APIs used internally, in the SQL tree, in the dialects, and in the criteria query API.
org.hibernate.query.criteria	The JPA-standard criteria query API defines all the operations needed express any query written in standard JPQL.
org.hibernate.query.derived
org.hibernate.query.hql	Package defining support for HQL, including JPQL as a subset of HQL.
org.hibernate.query.internal
org.hibernate.query.named	Support for named queries
org.hibernate.query.procedure	Support SQL functions in the SQM model.
org.hibernate.query.results	Support for defining result set mappings used in NativeQuery, ProcedureCall, and StoredProcedureQuery.
org.hibernate.query.spi	Contains a range of internal abstractions for dealing with query execution, query plans, query options, and query parameters.
org.hibernate.query.sql	Package defining support for native SQL queries.
org.hibernate.query.sqm	This package defines a semantic model of HQL queries.

Class	Description
BindableType<J>	Types that can be used to handle binding Query parameters
BindingContext	A context within which a BindableType can be resolved to an instance of SqmExpressible.
CommonQueryContract	Defines the aspects of query execution and parameter binding that apply to all forms of querying: HQL/JPQL queries, native SQL queries, criteria queries, and stored procedure calls.
IllegalMutationQueryException	Indicates an attempt to call QueryProducer.createMutationQuery(String), QueryProducer.createNamedMutationQuery(String) or QueryProducer.createNativeMutationQuery(String) with a non-mutation query (generally a select query)
IllegalNamedQueryOptionsException	Indicates a named-query has specified options that are not legal
IllegalQueryOperationException	Thrown when an operation of the Query interface is called which is unsupported due to the nature of the query itself.
IllegalSelectQueryException	Indicates an attempt to call QueryProducer.createSelectionQuery(String) with a non-selection query (generally a mutation query)
ImmutableEntityUpdateQueryHandlingMode	Controls for how immutable entities are handled when executing a bulk update statement.
KeyedPage<R>	Support for pagination based on a unique key of the result set instead of the offset.
KeyedPage.KeyInterpretation
KeyedResultList<R>	Support for pagination based on a unique key of the result set instead of the offset.
MutationQuery	Within the context of an active session, an instance of this type represents an executable mutation query, that is, an insert, update, or delete.
NamedQueryValidationException	Indicates that validation and translation of one or more named queries failed at initialization time.
NativeQuery<T>	Within the context of an active session, an instance of this type represents an executable query written in the native SQL dialect of the underlying database.
NativeQuery.CollectionReturn	Allows access to further control how collection returns are mapped back from result sets.
NativeQuery.FetchReturn	Allows access to further control how join fetch returns are mapped back from result sets.
NativeQuery.InstantiationResultNode<J>
NativeQuery.ResultNode	Simple unification interface for all returns from the various addXYZ() methods.
NativeQuery.ReturnableResultNode	A NativeQuery.ResultNode which can be a query result.
NativeQuery.ReturnProperty	Allows access to further control how properties within a root or join fetch are mapped back from the result set.
NativeQuery.RootReturn	Allows access to further control how root returns are mapped back from result sets.
NotIndexedCollectionException	Indicates an attempt to use a non-indexed collection as indexed.
NullPrecedence	Deprecated. Use Jakarta Persistence Nulls instead.
Order<X>	A rule for sorting a query result set.
OutputableType<J>	Specialization of DomainType for types that can be used as a parameter output for a ProcedureCall.
Page	Identifies a page of query results by page size and page number.
ParameterLabelException	Indicates a problem with the labelling of query parameters.
ParameterMetadata	Access to known information about the parameters for a query.
PathException	Indicates a problem with a path expression in HQL/JPQL.
Query<R>	Within the context of an active session, an instance of this type represents an executable query, either: a query written in HQL, a named query written in HQL or native SQL, or a criteria query.
QueryArgumentException	An error that occurs binding an argument to a query parameter.
QueryFlushMode	Enumerates the possible flush modes for execution of a Query.
QueryLogging
QueryParameter<T>	Represents a parameter defined in the source (HQL/JPQL or criteria) query.
QueryProducer	Contract for things that can produce instances of Query and NativeQuery.
QueryTypeMismatchException	Indicates a mismatch between the expected and actual result types of a query.
ResultListTransformer<T>	Defines some processing performed on the overall result List of a Query before the result list is returned to the caller.
ReturnableType<T>	Specialization of DomainType for types that can be used as function returns
SelectionQuery<R>	Within the context of an active session, an instance of this type represents an executable selection query, that is, a select.
SemanticException	Represents an error in the semantics (meaning) of a HQL/JPQL query.
SortDirection	Enumerates the directions in which query results may be sorted.
SynchronizeableQuery	Represents the abstract notion of a query whose results are affected by the data stored in a given set of named query spaces.
SyntaxException	Represents a syntax error in a HQL/JPQL query.
TupleTransformer<T>	Defines some transformation applied to each result of a Query before the results are packaged as a List and returned to the caller.
TypedParameterValue<J>	Represents a typed argument to a query parameter.
TypedTupleTransformer<T>	Extension to TupleTransformer exposing the transformation target type.
UnknownNamedQueryException	Occurs when a named query is requested, and there is no known HQL or native SQL query registered under the given name.
UnknownParameterException	Indicates an attempt to find an unknown query parameter or an attempt to bind a value to an unknown query parameter
UnknownSqlResultSetMappingException	Indicates a request for named ResultSet mapping which could not be found