Hibernate Reactive API documentation (2.0.8.Final)

Hibernate Reactive is a reactive API for Hibernate ORM, supporting non-blocking database drivers and a reactive style of interaction with the database.

The central APIs are defined as inner interfaces of

An instance of Mutiny.SessionFactory or Stage.SessionFactory may be obtained by calling EntityManagerFactory.unwrap(Class).

The public API is organized into the following packages:

org.hibernate.reactive.mutiny APIs specific to usage with Mutiny reactive streams
org.hibernate.reactive.stage APIs specific to usage with CompletionStage
org.hibernate.reactive.common APIs common to both kinds of reactive stream
org.hibernate.reactive.id SPI for plugin custom identifier generation
org.hibernate.reactive.pool SPI for plugin custom connection pooling
org.hibernate.reactive.vertx SPI for plugin custom integration with Vert.x

SPIs are implemented as Hibernate services.

Packages not listed above are considered non-public and are subject to change without notice.

Packages 
Package Description
org.hibernate.reactive.boot.spi  
org.hibernate.reactive.common
APIs common to both Stage and Mutiny.
org.hibernate.reactive.common.spi  
org.hibernate.reactive.context
Strategies for associating state with the current reactive stream.
org.hibernate.reactive.engine
Reactive adaptations of Hibernate ORM's persistence actions.
org.hibernate.reactive.engine.jdbc  
org.hibernate.reactive.engine.spi  
org.hibernate.reactive.event
Handlers for reactive session events.
org.hibernate.reactive.example.nativesql  
org.hibernate.reactive.example.session  
org.hibernate.reactive.id
Reactive identifier generation.
org.hibernate.reactive.id.enhanced  
org.hibernate.reactive.id.factory.spi  
org.hibernate.reactive.id.insert  
org.hibernate.reactive.it  
org.hibernate.reactive.it.lazytoone  
org.hibernate.reactive.it.techempower  
org.hibernate.reactive.it.techempower.utils  
org.hibernate.reactive.it.verticle  
org.hibernate.reactive.loader.ast.spi  
org.hibernate.reactive.loader.entity  
org.hibernate.reactive.mutiny
An API for Hibernate Reactive where non-blocking operations are represented by a Mutiny Uni.
org.hibernate.reactive.persister.collection.mutation  
org.hibernate.reactive.persister.entity.mutation  
org.hibernate.reactive.pool
Abstracts reactive database access via ReactiveConnection and ReactiveConnectionPool.
org.hibernate.reactive.provider
Integration with Hibernate ORM, via the service architecture, along with APIs for starting and configuring Hibernate Reactive.
org.hibernate.reactive.provider.service  
org.hibernate.reactive.query  
org.hibernate.reactive.query.spi  
org.hibernate.reactive.query.sql.spi  
org.hibernate.reactive.query.sqm  
org.hibernate.reactive.query.sqm.mutation.spi  
org.hibernate.reactive.query.sqm.spi  
org.hibernate.reactive.session
Defines internal contracts between subsystems of Hibernate Reactive and the ReactiveSession.
org.hibernate.reactive.sql.exec.spi  
org.hibernate.reactive.sql.results  
org.hibernate.reactive.sql.results.graph  
org.hibernate.reactive.sql.results.graph.entity  
org.hibernate.reactive.sql.results.spi  
org.hibernate.reactive.stage
An API for Hibernate Reactive where non-blocking operations are represented by a Java CompletionStage.
org.hibernate.reactive.tuple  
org.hibernate.reactive.type.descriptor.jdbc  
org.hibernate.reactive.vertx
Integration with Vert.x.