Package org.hibernate.reactive.stage

Interface Stage.StatelessSession

All Superinterfaces:

Stage.Closeable

Enclosing interface:

Stage

public static interface Stage.StatelessSession
extends Stage.Closeable

A non-blocking counterpart to the Hibernate StatelessSession interface, which provides a command-oriented API for performing bulk operations against a database.

A stateless session does not implement a first-level cache nor interact with any second-level cache, nor does it implement transactional write-behind or automatic dirty checking, nor do operations cascade to associated instances. Changes to many to many associations and element collections may not be made persistent in a stateless session. Operations performed via a stateless session bypass Hibernate's event model and interceptors.

For certain kinds of work, a stateless session may perform slightly better than a stateful session.

In particular, for a session which loads many entities, use of a StatelessSession alleviates the need to call:

• Stage.Session.clear() or Stage.Session.detach(Object) to perform first-level cache management, and
• Stage.Session.setCacheMode(CacheMode) to bypass interaction with the second-level cache.

Stateless sessions are vulnerable to data aliasing effects, due to the lack of a first-level cache.

See Also:

StatelessSession

Method Summary

Modifier and Type	Method	Description
CompletionStage<Void>	close()	Close the reactive session and release the underlying database connection.
<T> jakarta.persistence.EntityGraph<T>	createEntityGraph(Class<T> rootType)	Create a new mutable EntityGraph
<T> jakarta.persistence.EntityGraph<T>	createEntityGraph(Class<T> rootType, String graphName)	Create a new mutable copy of a named EntityGraph
Stage.MutationQuery	createMutationQuery(String queryString)	Create an instance of Stage.MutationQuery for the given HQL/JPQL update or delete statement.
<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.Query for the named query.
<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.MutationQuery	createQuery(jakarta.persistence.criteria.CriteriaDelete<R> criteriaDelete)	Create an instance of Stage.MutationQuery for the given criteria delete.
<R> Stage.SelectionQuery<R>	createQuery(jakarta.persistence.criteria.CriteriaQuery<R> criteriaQuery)	Create an instance of Stage.SelectionQuery for the given criteria query.
<R> Stage.MutationQuery	createQuery(jakarta.persistence.criteria.CriteriaUpdate<R> criteriaUpdate)	Create an instance of Stage.MutationQuery for the given criteria update.
<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.
Stage.Transaction	currentTransaction()	Obtain the transaction currently associated with this session, if any.
CompletionStage<Void>	delete(int batchSize, Object... entities)	Delete multiple rows.
CompletionStage<Void>	delete(Object entity)	Delete a row.
CompletionStage<Void>	delete(Object... entities)	Delete multiple rows.
<T> CompletionStage<T>	fetch(T association)	Asynchronously fetch an association that's configured for lazy loading.
<T> CompletionStage<T>	get(jakarta.persistence.EntityGraph<T> entityGraph, Object id)	Retrieve a row, using the given EntityGraph as a fetch plan.
<T> CompletionStage<T>	get(Class<T> entityClass, Object id)	Retrieve a row.
default <T> CompletionStage<T>	get(Class<T> entityClass, Object id, jakarta.persistence.LockModeType lockModeType)	Retrieve a row, obtaining the specified lock mode.
<T> CompletionStage<T>	get(Class<T> entityClass, Object id, LockMode lockMode)	Retrieve a row, obtaining the specified lock mode.
<T> jakarta.persistence.EntityGraph<T>	getEntityGraph(Class<T> rootType, String graphName)	Obtain a named EntityGraph
Stage.SessionFactory	getFactory()	The Stage.SessionFactory which created this session.
<T> ResultSetMapping<T>	getResultSetMapping(Class<T> resultType, String mappingName)	Obtain a native SQL result set mapping defined via the annotation SqlResultSetMapping.
CompletionStage<Void>	insert(int batchSize, Object... entities)	Insert multiple rows.
CompletionStage<Void>	insert(Object entity)	Insert a row.
CompletionStage<Void>	insert(Object... entities)	Insert multiple rows.
boolean	isOpen()
CompletionStage<Void>	refresh(int batchSize, Object... entities)	Refresh the entity instance state from the database.
CompletionStage<Void>	refresh(Object entity)	Refresh the entity instance state from the database.
CompletionStage<Void>	refresh(Object... entities)	Refresh the entity instance state from the database.
default CompletionStage<Void>	refresh(Object entity, jakarta.persistence.LockModeType lockModeType)	Refresh the entity instance state from the database.
CompletionStage<Void>	refresh(Object entity, LockMode lockMode)	Refresh the entity instance state from the database.
CompletionStage<Void>	update(int batchSize, Object... entities)	Update multiple rows.
CompletionStage<Void>	update(Object entity)	Update a row.
CompletionStage<Void>	update(Object... entities)	Update multiple rows.
CompletionStage<Void>	upsert(Object entity)
CompletionStage<Void>	upsert(String entityName, Object entity)
<T> CompletionStage<T>	withTransaction(Function<Stage.Transaction,CompletionStage<T>> work)	Performs the given work within the scope of a database transaction, automatically flushing the session.

Method Detail

get

<T> CompletionStage<T> get(Class<T> entityClass,
                           Object id)

Retrieve a row.

Parameters:

entityClass - The class of the entity to retrieve

id - The id of the entity to retrieve

Returns:

a detached entity instance, via a CompletionStage

See Also:

StatelessSession.get(Class, Object)

get

<T> CompletionStage<T> get(Class<T> entityClass,
                           Object id,
                           LockMode lockMode)

Retrieve a row, obtaining the specified lock mode.

Parameters:

entityClass - The class of the entity to retrieve

id - The id of the entity to retrieve

lockMode - The lock mode to apply to the entity

Returns:

a detached entity instance, via a CompletionStage

See Also:

StatelessSession.get(Class, Object, LockMode)

get

default <T> CompletionStage<T> get(Class<T> entityClass,
                                   Object id,
                                   jakarta.persistence.LockModeType lockModeType)

Retrieve a row, obtaining the specified lock mode.

Parameters:

entityClass - The class of the entity to retrieve

id - The id of the entity to retrieve

lockModeType - The lock mode to apply to the entity

Returns:

a detached entity instance, via a CompletionStage

See Also:

StatelessSession.get(Class, Object, LockMode)

get

<T> CompletionStage<T> get(jakarta.persistence.EntityGraph<T> entityGraph,
                           Object id)

Retrieve a row, using the given EntityGraph as a fetch plan.

Parameters:

entityGraph - an EntityGraph specifying the entity and associations to be fetched

id - The id of the entity to retrieve

Returns:

a detached entity instance, via a CompletionStage

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:

Session.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:

Session.createQuery(String, Class)

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)

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.

Parameters:

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

See Also:

QueryProducer.createNativeQuery(String)

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.Query 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.Query 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.

Parameters:

queryString - The SQL query

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

Returns:

The Stage.Query instance for manipulation and execution

See Also:

QueryProducer.createNativeQuery(String, Class)

createQuery

<R> Stage.SelectionQuery<R> createQuery(jakarta.persistence.criteria.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)

createQuery

<R> Stage.MutationQuery createQuery(jakarta.persistence.criteria.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

See Also:

EntityManager.createQuery(String)

createQuery

<R> Stage.MutationQuery createQuery(jakarta.persistence.criteria.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

See Also:

EntityManager.createQuery(String)

insert

CompletionStage<Void> insert(Object entity)

Insert a row.

Parameters:

entity - a new transient instance

See Also:

StatelessSession.insert(Object)

insert

CompletionStage<Void> insert(Object... entities)

Insert multiple rows.

Parameters:

entities - new transient instances

See Also:

StatelessSession.insert(Object)

insert

CompletionStage<Void> insert(int batchSize,
                             Object... entities)

Insert multiple rows.

Parameters:

batchSize - the batch size

entities - new transient instances

See Also:

StatelessSession.insert(Object)

delete

CompletionStage<Void> delete(Object entity)

Delete a row.

Parameters:

entity - a detached entity instance

See Also:

StatelessSession.delete(Object)

delete

CompletionStage<Void> delete(Object... entities)

Delete multiple rows.

Parameters:

entities - detached entity instances

See Also:

StatelessSession.delete(Object)

delete

CompletionStage<Void> delete(int batchSize,
                             Object... entities)

Delete multiple rows.

Parameters:

batchSize - the batch size

entities - detached entity instances

See Also:

StatelessSession.delete(Object)

update

CompletionStage<Void> update(Object entity)

Update a row.

Parameters:

entity - a detached entity instance

See Also:

StatelessSession.update(Object)

update

CompletionStage<Void> update(Object... entities)

Update multiple rows.

Parameters:

entities - a detached entity instance

See Also:

StatelessSession.update(Object)

update

CompletionStage<Void> update(int batchSize,
                             Object... entities)

Update multiple rows.

Parameters:

batchSize - the batch size

entities - a detached entity instance

See Also:

StatelessSession.update(Object)

refresh

CompletionStage<Void> refresh(Object entity)

Refresh the entity instance state from the database.

Parameters:

entity - The entity to be refreshed.

See Also:

StatelessSession.refresh(Object)

refresh

CompletionStage<Void> refresh(Object... entities)

Refresh the entity instance state from the database.

Parameters:

entities - The entities to be refreshed.

See Also:

StatelessSession.refresh(Object)

refresh

CompletionStage<Void> refresh(int batchSize,
                              Object... entities)

Refresh the entity instance state from the database.

Parameters:

batchSize - the batch size

entities - The entities to be refreshed.

See Also:

StatelessSession.refresh(Object)

refresh

CompletionStage<Void> refresh(Object entity,
                              LockMode lockMode)

Refresh the entity instance state from the database.

Parameters:

entity - The entity to be refreshed.

lockMode - The LockMode to be applied.

See Also:

StatelessSession.refresh(Object, LockMode)

refresh

default CompletionStage<Void> refresh(Object entity,
                                      jakarta.persistence.LockModeType lockModeType)

Refresh the entity instance state from the database.

Parameters:

entity - The entity to be refreshed.

lockModeType - The LockMode to be applied.

See Also:

StatelessSession.refresh(Object, LockMode)

upsert

CompletionStage<Void> upsert(Object entity)

Parameters:

entity - a detached entity instance

See Also:

StatelessSession.upsert(Object)

upsert

CompletionStage<Void> upsert(String entityName,
                             Object entity)

Parameters:

entityName - The entityName for the entity to be merged

entity - a detached entity instance

See Also:

StatelessSession.upsert(String, Object)

fetch

<T> CompletionStage<T> fetch(T association)

Asynchronously fetch an association that's configured for lazy loading.

 session.fetch(author.getBook()).thenAccept(book -> print(book.getTitle()))
 

Warning: this operation in a stateless session is quite sensitive to data aliasing effects and should be used with great care.

Parameters:

association - a lazy-loaded association

Returns:

the fetched association, via a CompletionStage

See Also:

Hibernate.initialize(Object)

getResultSetMapping

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

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

getEntityGraph

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

Obtain a named EntityGraph

createEntityGraph

<T> jakarta.persistence.EntityGraph<T> createEntityGraph(Class<T> rootType)

Create a new mutable EntityGraph

createEntityGraph

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

Create a new mutable copy of a named EntityGraph

withTransaction

<T> CompletionStage<T> withTransaction(Function<Stage.Transaction,CompletionStage<T>> work)

Performs the given work within the scope of a database transaction, automatically flushing the session. The transaction will be rolled back if the work completes with an uncaught exception, or if Stage.Transaction.markForRollback() is called.

If there is already a transaction associated with this session, the work is executed in the context of the existing transaction, and no new transaction is initiated. If there is no transaction associated with this session, a new transaction is started, and the work is executed in the context of the new transaction.

Parameters:

work - a function which accepts Stage.Transaction and returns the result of the work as a CompletionStage.

See Also:

Stage.SessionFactory.withTransaction(BiFunction)

currentTransaction

Stage.Transaction currentTransaction()

Obtain the transaction currently associated with this session, if any.

Returns:

the Stage.Transaction, or null if no transaction was started using withTransaction(Function).

See Also:

withTransaction(Function), Stage.SessionFactory.withTransaction(BiFunction)

isOpen

boolean isOpen()

Returns:

false if close() has been called

close

CompletionStage<Void> close()

Close the reactive session and release the underlying database connection.

Specified by:

close in interface Stage.Closeable

getFactory

Stage.SessionFactory getFactory()

The Stage.SessionFactory which created this session.