Package org.hibernate.reactive.stage

Interface Stage.StatelessSession

All Superinterfaces:

Stage.Closeable, Stage.QueryProducer

Enclosing interface:

Stage

public static interface Stage.StatelessSession
extends Stage.QueryProducer, 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.
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, using the number of the given entities as the batch size.
CompletionStage<Void>	deleteMultiple(List<?> entities)	Delete multiple rows, using the size of the given list as the batch size.
<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.
<T> CompletionStage<List<T>>	get(Class<T> entityClass, Object... ids)	Retrieve multiple rows.
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.
default jakarta.persistence.criteria.CriteriaBuilder	getCriteriaBuilder()	Convenience method to obtain the CriteriaBuilder.
Stage.SessionFactory	getFactory()	The Stage.SessionFactory which created this session.
Object	getIdentifier(Object entity)	Return the identifier value of the given entity, which may be detached.
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, using the number of the given entities as the batch size.
CompletionStage<Void>	insertMultiple(List<?> entities)	Insert multiple rows, using the size of the given list as the batch size.
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, using the number of the given entities as the batch size.
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>	refreshMultiple(List<?> entities)	Refresh the entity instance state from the database, using the size of the given list as the batch size.
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, using the number of the given entities as the batch size.
CompletionStage<Void>	updateMultiple(List<?> entities)	Update multiple rows, using the size of the given list as the batch size.
CompletionStage<Void>	upsert(Object entity)
CompletionStage<Void>	upsertAll(int batchSize, Object... entities)	Use a SQL merge into statement to perform an upsert on multiple rows using the specified batch size.
CompletionStage<Void>	upsertAll(Object... entities)	Use a SQL merge into statement to perform an upsert on multiple rows using the size of the given array as batch size.
CompletionStage<Void>	upsertMultiple(List<?> entities)	Use a SQL merge into statement to perform an upsert on multiple rows using the size of the given list as batch size.
<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.

Methods inherited from interface org.hibernate.reactive.stage.Stage.QueryProducer

createEntityGraph, createEntityGraph, createMutationQuery, createMutationQuery, createMutationQuery, createMutationQuery, createNamedQuery, createNamedQuery, createNativeQuery, createNativeQuery, createNativeQuery, createNativeQuery, createNativeQuery, createNativeQuery, createQuery, createQuery, createQuery, createQuery, createQuery, createQuery, createSelectionQuery, getEntityGraph, getResultSetMapping

Method Details

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<List<T>> get(Class<T> entityClass,
 Object... ids)

Retrieve multiple rows.

Parameters:

entityClass - The class of the entity to retrieve

ids - The ids of the entities to retrieve

Returns:

a list of detached entity instances, via a Uni

See Also:

• StatelessSession.getMultiple(Class, List)

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

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, using the number of the given entities as the batch size.

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)

insertMultiple

CompletionStage<Void> insertMultiple(List<?> entities)

Insert multiple rows, using the size of the given list as the batch size.

Parameters:

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, using the number of the given entities as the batch size.

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)

deleteMultiple

CompletionStage<Void> deleteMultiple(List<?> entities)

Delete multiple rows, using the size of the given list as the batch size.

Parameters:

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, using the number of the given entities as the batch size.

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)

updateMultiple

CompletionStage<Void> updateMultiple(List<?> entities)

Update multiple rows, using the size of the given list as the batch size.

Parameters:

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, using the number of the given entities as the batch size.

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)

refreshMultiple

CompletionStage<Void> refreshMultiple(List<?> entities)

Refresh the entity instance state from the database, using the size of the given list as the batch size.

Parameters:

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)

upsertAll

@Incubating
CompletionStage<Void> upsertAll(Object... entities)

Use a SQL merge into statement to perform an upsert on multiple rows using the size of the given array as batch size.

Parameters:

entities - the entities to upsert

See Also:

• StatelessSession.upsert(Object)

upsertAll

@Incubating
CompletionStage<Void> upsertAll(int batchSize,
 Object... entities)

Use a SQL merge into statement to perform an upsert on multiple rows using the specified batch size.

Parameters:

batchSize - the batch size

entities - the list of entities to upsert

See Also:

• StatelessSession.upsert(Object)

upsertMultiple

@Incubating
CompletionStage<Void> upsertMultiple(List<?> entities)

Use a SQL merge into statement to perform an upsert on multiple rows using the size of the given list as batch size.

Parameters:

entities - the entities to upsert

See Also:

• StatelessSession.upsert(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)

getIdentifier

Object getIdentifier(Object entity)

Return the identifier value of the given entity, which may be detached.

Parameters:

entity - a persistent instance associated with this session

Returns:

the identifier

Since:

3.0

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.

getCriteriaBuilder

default jakarta.persistence.criteria.CriteriaBuilder getCriteriaBuilder()

Convenience method to obtain the CriteriaBuilder.

Specified by:

getCriteriaBuilder in interface Stage.QueryProducer

Since:

3