Skip navigation links

Hibernate JavaDoc (6.0.0.Alpha6)

Hibernate O/RM Aggregated JavaDocs

See: Description

Packages 
Package Description
org.hibernate
This package defines the central Hibernate APIs.
org.hibernate.action.spi
Defines SPI hooks into the ActionQueue.
org.hibernate.annotations
Package containing all the Hibernate specific annotations.
org.hibernate.boot
This package contains the contracts that make up the Hibernate native bootstrapping API (building a SessionFactory).
org.hibernate.boot.archive.scan.spi  
org.hibernate.boot.archive.spi
Defines the SPI for support of "scanning" of "archives".
org.hibernate.boot.cfgxml.spi  
org.hibernate.boot.jaxb  
org.hibernate.boot.jaxb.cfg.spi  
org.hibernate.boot.jaxb.hbm.spi  
org.hibernate.boot.jaxb.spi  
org.hibernate.boot.model
Package defining Hibernate's boot-time metamodel, which is an incrementally built understanding of the application's domain model (its entities, attributes, etc).
org.hibernate.boot.model.convert.spi  
org.hibernate.boot.model.naming
Represents a proposed new approach to allowing hooks into the process of determining the name of database objects (tables, columns, constraints, etc).
org.hibernate.boot.model.process.spi  
org.hibernate.boot.model.relational  
org.hibernate.boot.model.source.spi  
org.hibernate.boot.query  
org.hibernate.boot.registry
Defines service registry contracts application are likely to want to utilize for configuring Hibernate behavior.
org.hibernate.boot.registry.classloading.spi
The class loading service SPI.
org.hibernate.boot.registry.selector
Defines a feature-set around named registration of implementations of various contracts and the ability to select those implementations.
org.hibernate.boot.registry.selector.spi
Defines actual contract used for strategy selection : StrategySelector.
org.hibernate.boot.spi  
org.hibernate.boot.xsd
Support for XSD handling, specifically for ORM mappings (Hibernate's `hbm.xml` and JPA's `orm.xml`) and config files (Hibernate's `cfg.xml` and JPA's `persistence.xml`)
org.hibernate.bytecode
This package defines the API for plugging in bytecode libraries for usage by Hibernate.
org.hibernate.bytecode.enhance.spi
package defining bytecode code enhancement (instrumentation) support.
org.hibernate.bytecode.enhance.spi.interceptor
interceptor implementations
org.hibernate.bytecode.spi
Package defining bytecode code enhancement (instrumentation) support.
org.hibernate.cache
This package defines API of the Hibernate second level cache service.
org.hibernate.cache.cfg.spi  
org.hibernate.cache.jcache
Hibernate caching provider for JSR-107 compliant caches.
org.hibernate.cache.spi
Defines the integration aspect of Hibernate's second-level caching allowing "caching back ends" to be plugged in as a caching provider.
org.hibernate.cache.spi.access
Defines contracts for transactional and concurrent access to cached entity and collection data.
org.hibernate.cache.spi.entry
This package defines formats for disassembled state kept in the second level cache.
org.hibernate.cache.spi.support
Package intended for simplifying the worked needed to implement a caching provider.
org.hibernate.cfg
This package defines APIs for configuring Hibernate, and classes for building the Hibernate configuration-time metamodel.
org.hibernate.cfg.annotations  
org.hibernate.cfg.annotations.reflection
Defines the capability to merge mapping information from both annotations and orm.xml sources into a unified set of metadata in the Hibernate commons-annotations model.
org.hibernate.cfg.beanvalidation  
org.hibernate.classic
This package implements backward-compatibility with Hibernate 2.1 APIs now deprecated in Hibernate3.
org.hibernate.collection.spi
SPI definitions for persistent collections
org.hibernate.context
Defines support for "current session" feature.
org.hibernate.context.spi
SPI level contracts around "current session" support.
org.hibernate.dialect
This package abstracts the SQL dialect of the underlying database.
org.hibernate.dialect.function
A framework for defining database-specific SQL functions that are available via the dialect.
org.hibernate.dialect.hint  
org.hibernate.dialect.identity  
org.hibernate.dialect.lock
Support for Dialect-specific locking strategies
org.hibernate.dialect.pagination
Support for Dialect-specific pagination strategies
org.hibernate.dialect.sequence  
org.hibernate.dialect.unique
Support for Dialect-specific unique constraint definition
org.hibernate.ejb  
org.hibernate.engine
This package contains classes that are "shared" by other packages, and implementations of some key algorithms.
org.hibernate.engine.config.spi
SPI Package for the configuration service.
org.hibernate.engine.jdbc
Support for various aspects of JDBC interaction
org.hibernate.engine.jdbc.batch.spi
Defines contracts for JDBC batching support.
org.hibernate.engine.jdbc.connections.spi
Defines contracts for accessing JDBC Connections
org.hibernate.engine.jdbc.cursor.spi
Defines contracts for JDBC REF_CURSOR support.
org.hibernate.engine.jdbc.dialect.spi
Contracts supporting Dialect resolution (from JDBC metadata) and Dialect building.
org.hibernate.engine.jdbc.env.spi  
org.hibernate.engine.jdbc.spi
SPI contracts for supporting various aspects of JDBC interaction
org.hibernate.engine.jndi
Support for JNDI within Hibernate
org.hibernate.engine.jndi.spi
The SPI contracts for Hibernate JNDI support
org.hibernate.engine.profile
Models the fetch profiles defined by the application
org.hibernate.engine.query  
org.hibernate.engine.query.spi
Defines support for query plans and stored metadata about queries
org.hibernate.engine.query.spi.sql  
org.hibernate.engine.spi  
org.hibernate.engine.transaction.jta.platform.spi  
org.hibernate.engine.transaction.spi  
org.hibernate.envers  
org.hibernate.envers.boot  
org.hibernate.envers.boot.spi  
org.hibernate.envers.configuration  
org.hibernate.envers.enhanced  
org.hibernate.envers.event.spi  
org.hibernate.envers.exception  
org.hibernate.envers.query  
org.hibernate.envers.query.criteria  
org.hibernate.envers.query.order  
org.hibernate.envers.query.projection  
org.hibernate.envers.strategy  
org.hibernate.envers.strategy.spi  
org.hibernate.envers.tools  
org.hibernate.event.service.spi  
org.hibernate.event.spi  
org.hibernate.exception
This package is a fork of Apache commons-lang nestable exceptions.
org.hibernate.exception.spi  
org.hibernate.grammars.graph  
org.hibernate.grammars.hql  
org.hibernate.grammars.importsql  
org.hibernate.grammars.ordering  
org.hibernate.graph
Hibernate's (extended) support for JPA's entity graphs
org.hibernate.graph.spi  
org.hibernate.id
This package contains internal implementation classes for the main API interfaces.
org.hibernate.id.enhanced
Enhanced/improved versions of table and sequence based identifier generators targeting portability and unified configuration
org.hibernate.id.factory  
org.hibernate.id.factory.spi  
org.hibernate.id.insert  
org.hibernate.id.uuid  
org.hibernate.integrator.spi  
org.hibernate.jdbc
Essentially defines Work, ReturningWork and Expectation as well as some exceptions
org.hibernate.jmx.spi  
org.hibernate.jpa  
org.hibernate.jpa.boot.spi  
org.hibernate.jpa.event.spi
The SPI contracts for supporting JPA lifecycle callbacks.
org.hibernate.jpa.event.spi.jpa  
org.hibernate.jpa.spi  
org.hibernate.jpamodelgen
The main package of this annotation processor.
org.hibernate.jpamodelgen.annotation
Implementation of the model classes backed by annotations.
org.hibernate.jpamodelgen.model  
org.hibernate.jpamodelgen.util
Helper classes for string and type processing as well as access type detection.
org.hibernate.jpamodelgen.util.xml
XML helper classes.
org.hibernate.jpamodelgen.xml
Implementation of the model classes backed by annotations.
org.hibernate.jpamodelgen.xml.jaxb  
org.hibernate.loader
This package defines functionality for processing JDBC result sets and returning complex graphs of persistent objects.
org.hibernate.loader.ast.spi  
org.hibernate.loader.entity  
org.hibernate.lob  
org.hibernate.mapping
This package defines the Hibernate configuration-time metamodel.
org.hibernate.metadata
This package defines an API for accessing the Hibernate runtime metamodel.
org.hibernate.metamodel
This entire package (including sub-packages) is considered incubating
org.hibernate.metamodel.mapping
Hibernate's run-time mapping model.
org.hibernate.metamodel.mapping.ordering
Support for set and map ordering
org.hibernate.metamodel.mapping.ordering.ast  
org.hibernate.metamodel.model.convert
Support for basic-value conversions.
org.hibernate.metamodel.model.convert.spi  
org.hibernate.metamodel.model.domain
Hibernate extensions to and implementations of the JPA metamodel
org.hibernate.metamodel.relational  
org.hibernate.metamodel.spi  
org.hibernate.orm.tooling.maven  
org.hibernate.osgi
Main OSGi support classes
org.hibernate.param  
org.hibernate.persister.collection
This package abstracts the persistence mechanism for collections.
org.hibernate.persister.entity
This package abstracts persistence mechanisms for entities, and defines the Hibernate runtime metamodel.
org.hibernate.persister.spi  
org.hibernate.persister.walking.spi  
org.hibernate.pretty
Classes for pretty printing things for exception and log messages.
org.hibernate.procedure  
org.hibernate.procedure.spi  
org.hibernate.property.access.spi
Defines strategies for accessing the persistent properties of an entity or composite.
org.hibernate.proxy
This package defines a framework for lazy-initializing entity proxies.
org.hibernate.proxy.map  
org.hibernate.proxy.pojo  
org.hibernate.proxy.pojo.bytebuddy  
org.hibernate.query  
org.hibernate.query.criteria
Hibernate's support for JPA criteria queries.
org.hibernate.query.hql
Package defining support for HQL queries (including supprt for JPQL as a subset of HQL).
org.hibernate.query.hql.spi  
org.hibernate.query.named  
org.hibernate.query.procedure  
org.hibernate.query.results
Support for defining result-set mappings used in NativeQuery and ProcedureCall / StoredProcedureQuery.
org.hibernate.query.results.complete
Support for immutable result/fetch builder graph nodes built from static sources such as JPA's SqlResultSetMapping or `hbm.xml` mapping ``.
org.hibernate.query.results.dynamic
Support for mutable result/fetch builder graphs nodes built dynamically via Hibernate's NativeQuery APIs
org.hibernate.query.results.implicit
Defines support for implicit ResultSet mappings.
org.hibernate.query.spi  
org.hibernate.query.sql.spi  
org.hibernate.query.sqm  
org.hibernate.query.sqm.function  
org.hibernate.query.sqm.mutation.spi  
org.hibernate.query.sqm.produce.function
Package defining support for SqmFunctionDescriptor handling.
org.hibernate.query.sqm.spi
SPI-level SQM contracts
org.hibernate.query.sqm.sql
Package for the translation of SQM into SQL AST
org.hibernate.query.sqm.tree
This package contains the classes that make up the SQM tree nodes.
org.hibernate.query.sqm.tree.cte  
org.hibernate.query.sqm.tree.delete  
org.hibernate.query.sqm.tree.domain  
org.hibernate.query.sqm.tree.expression  
org.hibernate.query.sqm.tree.from  
org.hibernate.query.sqm.tree.insert  
org.hibernate.query.sqm.tree.jpa  
org.hibernate.query.sqm.tree.predicate  
org.hibernate.query.sqm.tree.select  
org.hibernate.query.sqm.tree.update  
org.hibernate.resource.beans.container.spi  
org.hibernate.resource.beans.spi  
org.hibernate.resource.jdbc  
org.hibernate.resource.jdbc.spi  
org.hibernate.resource.transaction
Defines the resource-level transaction capabilities of Hibernate, which revolves around the TransactionCoordinator contract.
org.hibernate.resource.transaction.backend.jdbc.spi  
org.hibernate.resource.transaction.spi
Extended SPI contracts for the resource-level transaction capabilities of Hibernate.
org.hibernate.result  
org.hibernate.result.spi  
org.hibernate.secure.spi  
org.hibernate.service  
org.hibernate.service.spi  
org.hibernate.sql
This package defines helper classes for rendering SQL fragments and SQL statements.
org.hibernate.sql.ast
Package defining a SQL AST for use in creating and executing various JDBC operations
org.hibernate.sql.ast.spi
Package defining support for creating and consuming SQL AST
org.hibernate.sql.ast.tree
Package defining the SQL AST.
org.hibernate.sql.ast.tree.cte  
org.hibernate.sql.ast.tree.delete  
org.hibernate.sql.ast.tree.expression
Contracts related to expressions in a SQL tree
org.hibernate.sql.ast.tree.from  
org.hibernate.sql.ast.tree.insert  
org.hibernate.sql.ast.tree.predicate  
org.hibernate.sql.ast.tree.select  
org.hibernate.sql.ast.tree.update  
org.hibernate.sql.exec
Package defining support for execution of SQL statements through JDBC.
org.hibernate.sql.exec.spi  
org.hibernate.sql.results
Package for processing JDBC ResultSets into hydrated domain model graphs based on a "load plan" defined by a "domain result graph" - one or more DomainResult nodes with zero-or-more Fetch nodes
org.hibernate.sql.results.caching
Support for caching of query results
org.hibernate.sql.results.graph  
org.hibernate.sql.results.graph.basic  
org.hibernate.sql.results.graph.collection  
org.hibernate.sql.results.graph.embeddable  
org.hibernate.sql.results.graph.entity  
org.hibernate.sql.results.graph.instantiation  
org.hibernate.sql.results.jdbc.spi  
org.hibernate.sql.results.spi  
org.hibernate.stat
This package exposes statistics about a running Hibernate instance to the application.
org.hibernate.stat.spi  
org.hibernate.testing  
org.hibernate.testing.async  
org.hibernate.testing.boot  
org.hibernate.testing.bytecode.enhancement  
org.hibernate.testing.byteman  
org.hibernate.testing.cache  
org.hibernate.testing.common.connections  
org.hibernate.testing.env  
org.hibernate.testing.hamcrest  
org.hibernate.testing.jdbc  
org.hibernate.testing.jdbc.leak  
org.hibernate.testing.jta  
org.hibernate.testing.junit4  
org.hibernate.testing.junit5
Extensions based on the extension mechanism of JUnit 5 to support things like `@FailureExcepted`, `@RequiresDialect`, etc.
org.hibernate.testing.junit5.dynamictests  
org.hibernate.testing.junit5.schema  
org.hibernate.testing.junit5.serviceregistry  
org.hibernate.testing.junit5.template  
org.hibernate.testing.logger  
org.hibernate.testing.orm.domain  
org.hibernate.testing.orm.domain.contacts  
org.hibernate.testing.orm.domain.gambit  
org.hibernate.testing.orm.domain.helpdesk  
org.hibernate.testing.orm.domain.retail  
org.hibernate.testing.orm.junit  
org.hibernate.testing.schema  
org.hibernate.testing.transaction  
org.hibernate.testing.util  
org.hibernate.testing.util.jpa  
org.hibernate.tool.enhance  
org.hibernate.tool.hbm2ddl
The hbm2ddl tool.
org.hibernate.tool.schema  
org.hibernate.tool.schema.extract.spi  
org.hibernate.tool.schema.spi  
org.hibernate.transform
Defines strategies for post-processing criteria query result sets into a form convenient to the application.
org.hibernate.tuple
This package defines a runtime metamodel for entities at the object level and abstracts the differences between the various entity modes.
org.hibernate.tuple.component  
org.hibernate.tuple.entity  
org.hibernate.type
A Hibernate Type is a strategy for mapping a Java property type to a JDBC type or types.
org.hibernate.type.descriptor  
org.hibernate.type.descriptor.converter
Support for handling JPA AttributeConverter instances as part of the Hibernate Type system.
org.hibernate.type.descriptor.java  
org.hibernate.type.descriptor.java.spi  
org.hibernate.type.descriptor.sql
Defines handling of the standard JDBC-defined types.
org.hibernate.type.descriptor.sql.spi  
org.hibernate.type.spi  
org.hibernate.usertype
Interfaces for user-defined custom types.

Hibernate O/RM Aggregated JavaDocs

Hibernate provides both

Native API

In addition to SessionFactory and Session, applications using the native API will often utilize the following interfaces: These interfaces are fully intended to be exposed to application code.

JPA

The JPA interfaces are all defined by the JPA specification. For details see javax.persistence. Not that since 5.2 Hibernate extends JPA (e.g. SessionFactory extends EntityManagerFactory) rather than wrapping it.

Note about package categories

Hibernate categorizes packages into a number of groups based on intended consumers:

Complete Hibernate documentation may be found online at http://hibernate.org/orm/documentation/
Skip navigation links

Copyright © 2001-2020 Red Hat, Inc. All Rights Reserved.