Package org.springframework.data.r2dbc.core

Class R2dbcEntityTemplate

java.lang.Object

org.springframework.data.r2dbc.core.R2dbcEntityTemplate

All Implemented Interfaces:

Aware, BeanFactoryAware, ApplicationContextAware, FluentR2dbcOperations, R2dbcEntityOperations, ReactiveDeleteOperation, ReactiveInsertOperation, ReactiveSelectOperation, ReactiveUpdateOperation

public class R2dbcEntityTemplate
extends Object
implements R2dbcEntityOperations, BeanFactoryAware, ApplicationContextAware

Implementation of R2dbcEntityOperations. It simplifies the use of Reactive R2DBC usage through entities and helps to avoid common errors. This class uses DatabaseClient to execute SQL queries or updates, initiating iteration over Result.

Can be used within a service implementation via direct instantiation with a DatabaseClient reference, or get prepared in an application context and given to services as bean reference.

Since:

1.1

Author:

Mark Paluch, Bogdan Ilchyshyn, Jens Schauder, Jose Luis Leon, Robert Heim, Sebastian Wieland, Mikhail Polivakha

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.data.r2dbc.core.ReactiveDeleteOperation

ReactiveDeleteOperation.DeleteWithQuery, ReactiveDeleteOperation.DeleteWithTable, ReactiveDeleteOperation.ReactiveDelete, ReactiveDeleteOperation.TerminatingDelete

Nested classes/interfaces inherited from interface org.springframework.data.r2dbc.core.ReactiveInsertOperation

ReactiveInsertOperation.InsertWithTable<T>, ReactiveInsertOperation.ReactiveInsert<T>, ReactiveInsertOperation.TerminatingInsert<T>

Nested classes/interfaces inherited from interface org.springframework.data.r2dbc.core.ReactiveSelectOperation

ReactiveSelectOperation.ReactiveSelect<T>, ReactiveSelectOperation.SelectWithProjection<T>, ReactiveSelectOperation.SelectWithQuery<T>, ReactiveSelectOperation.SelectWithTable<T>, ReactiveSelectOperation.TerminatingSelect<T>

Nested classes/interfaces inherited from interface org.springframework.data.r2dbc.core.ReactiveUpdateOperation

ReactiveUpdateOperation.ReactiveUpdate, ReactiveUpdateOperation.TerminatingUpdate, ReactiveUpdateOperation.UpdateWithQuery, ReactiveUpdateOperation.UpdateWithTable

Constructor Summary

Constructors

Constructor	Description
R2dbcEntityTemplate(ConnectionFactory connectionFactory)	Create a new R2dbcEntityTemplate given ConnectionFactory.
R2dbcEntityTemplate(DatabaseClient databaseClient, ReactiveDataAccessStrategy strategy)	Create a new R2dbcEntityTemplate given DatabaseClient and ReactiveDataAccessStrategy.
R2dbcEntityTemplate(DatabaseClient databaseClient, R2dbcDialect dialect)	Create a new R2dbcEntityTemplate given DatabaseClient.
R2dbcEntityTemplate(DatabaseClient databaseClient, R2dbcDialect dialect, R2dbcConverter converter)	Create a new R2dbcEntityTemplate given DatabaseClient, R2dbcDialect and R2dbcConverter.

Method Summary

Modifier and Type	Method	Description
Mono<Long>	count(org.springframework.data.relational.core.query.Query query, Class<?> entityClass)	Returns the number of rows for the given entity class applying Query.
ReactiveDeleteOperation.ReactiveDelete	delete(Class<?> domainType)	Begin creating a DELETE operation for the given domainType.
Mono<Long>	delete(org.springframework.data.relational.core.query.Query query, Class<?> entityClass)	Remove entities (rows)/columns from the table by Query.
<T> Mono<T>	delete(T entity)	Delete the given entity and emit the entity if the delete was applied.
Mono<Boolean>	exists(org.springframework.data.relational.core.query.Query query, Class<?> entityClass)	Determine whether the result for entityClass Query yields at least one row.
R2dbcConverter	getConverter()	Return the underlying R2dbcConverter.
ReactiveDataAccessStrategy	getDataAccessStrategy()	Expose the underlying ReactiveDataAccessStrategy encapsulating dialect specifics.
DatabaseClient	getDatabaseClient()	Expose the underlying DatabaseClient to allow SQL operations.
<T> RowsFetchSpec<T>	getRowsFetchSpec(DatabaseClient.GenericExecuteSpec executeSpec, Class<?> entityType, Class<T> resultType)
<T> ReactiveInsertOperation.ReactiveInsert<T>	insert(Class<T> domainType)	Begin creating an INSERT operation for given domainType.
<T> Mono<T>	insert(T entity)	Insert the given entity and emit the entity if the insert was applied.
protected <T> Mono<T>	maybeCallAfterConvert(T object, org.springframework.data.relational.core.sql.SqlIdentifier table)
protected <T> Mono<T>	maybeCallAfterSave(T object, OutboundRow row, org.springframework.data.relational.core.sql.SqlIdentifier table)
protected <T> Mono<T>	maybeCallBeforeConvert(T object, org.springframework.data.relational.core.sql.SqlIdentifier table)
protected <T> Mono<T>	maybeCallBeforeSave(T object, OutboundRow row, org.springframework.data.relational.core.sql.SqlIdentifier table)
<T> RowsFetchSpec<T>	query(PreparedOperation<?> operation, Class<?> entityClass, Class<T> resultType)	Execute a query for a RowsFetchSpec, given PreparedOperation.
<T> RowsFetchSpec<T>	query(PreparedOperation<?> operation, Class<?> entityClass, BiFunction<Row,RowMetadata,T> rowMapper)	Execute a query for a RowsFetchSpec in the context of entityClass, given PreparedOperation.
<T> RowsFetchSpec<T>	query(PreparedOperation<?> operation, Class<T> entityClass)	Execute a query for a RowsFetchSpec, given PreparedOperation.
<T> RowsFetchSpec<T>	query(PreparedOperation<?> operation, BiFunction<Row,RowMetadata,T> rowMapper)	Execute a query for a RowsFetchSpec, given PreparedOperation.
<T> ReactiveSelectOperation.ReactiveSelect<T>	select(Class<T> domainType)	Begin creating a SELECT operation for the given domainType.
<T> Flux<T>	select(org.springframework.data.relational.core.query.Query query, Class<T> entityClass)	Execute a SELECT query and convert the resulting items to a stream of entities.
<T> Mono<T>	selectOne(org.springframework.data.relational.core.query.Query query, Class<T> entityClass)	Execute a SELECT query and convert the resulting item to an entity ensuring exactly one result.
void	setApplicationContext(ApplicationContext applicationContext)
void	setBeanFactory(BeanFactory beanFactory)	Deprecated.
void	setEntityCallbacks(ReactiveEntityCallbacks entityCallbacks)	Set the ReactiveEntityCallbacks instance to use when invoking callbacks like the BeforeSaveCallback.
void	setStatementFilterFunction(Function<Statement,Statement> statementFilterFunction)	Set a Statement Filter Function that is applied to every Statement.
ReactiveUpdateOperation.ReactiveUpdate	update(Class<?> domainType)	Begin creating an UPDATE operation for the given domainType.
Mono<Long>	update(org.springframework.data.relational.core.query.Query query, org.springframework.data.relational.core.query.Update update, Class<?> entityClass)	Update the queried entities and return true if the update was applied.
<T> Mono<T>	update(T entity)	Update the given entity and emit the entity if the update was applied.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.data.r2dbc.core.R2dbcEntityOperations

query, query

Constructor Details

R2dbcEntityTemplate

public R2dbcEntityTemplate(ConnectionFactory connectionFactory)

Create a new R2dbcEntityTemplate given ConnectionFactory.

Parameters:

connectionFactory - must not be null.

Since:

1.2

R2dbcEntityTemplate

public R2dbcEntityTemplate(DatabaseClient databaseClient,
 R2dbcDialect dialect)

Create a new R2dbcEntityTemplate given DatabaseClient.

Parameters:

databaseClient - must not be null.

dialect - the dialect to use, must not be null.

Since:

1.2

R2dbcEntityTemplate

public R2dbcEntityTemplate(DatabaseClient databaseClient,
 R2dbcDialect dialect,
 R2dbcConverter converter)

Create a new R2dbcEntityTemplate given DatabaseClient, R2dbcDialect and R2dbcConverter.

Parameters:

databaseClient - must not be null.

dialect - the dialect to use, must not be null.

converter - the dialect to use, must not be null.

Since:

1.2

R2dbcEntityTemplate

public R2dbcEntityTemplate(DatabaseClient databaseClient,
 ReactiveDataAccessStrategy strategy)

Create a new R2dbcEntityTemplate given DatabaseClient and ReactiveDataAccessStrategy.

Parameters:

databaseClient - must not be null.

Since:

1.2

Method Details

setStatementFilterFunction

public void setStatementFilterFunction(Function<Statement,Statement> statementFilterFunction)

Set a Statement Filter Function that is applied to every Statement.

Parameters:

statementFilterFunction - must not be null.

Since:

3.4

getDatabaseClient

public DatabaseClient getDatabaseClient()

Description copied from interface: R2dbcEntityOperations

Expose the underlying DatabaseClient to allow SQL operations.

Specified by:

getDatabaseClient in interface R2dbcEntityOperations

Returns:

the underlying DatabaseClient.

See Also:

• DatabaseClient

getDataAccessStrategy

public ReactiveDataAccessStrategy getDataAccessStrategy()

Description copied from interface: R2dbcEntityOperations

Expose the underlying ReactiveDataAccessStrategy encapsulating dialect specifics.

Specified by:

getDataAccessStrategy in interface R2dbcEntityOperations

Returns:

the underlying ReactiveDataAccessStrategy.

See Also:

• ReactiveDataAccessStrategy

getConverter

public R2dbcConverter getConverter()

Description copied from interface: R2dbcEntityOperations

Return the underlying R2dbcConverter.

Specified by:

getConverter in interface R2dbcEntityOperations

Returns:

the underlying R2dbcConverter.

setBeanFactory

@Deprecated
public void setBeanFactory(BeanFactory beanFactory)
                    throws BeansException

Deprecated.

Specified by:

setBeanFactory in interface BeanFactoryAware

Throws:

BeansException

setApplicationContext

public void setApplicationContext(ApplicationContext applicationContext)
                           throws BeansException

Specified by:

setApplicationContext in interface ApplicationContextAware

Throws:

BeansException

setEntityCallbacks

public void setEntityCallbacks(ReactiveEntityCallbacks entityCallbacks)

Set the ReactiveEntityCallbacks instance to use when invoking callbacks like the BeforeSaveCallback.

Overrides potentially existing ReactiveEntityCallbacks.

Parameters:

entityCallbacks - must not be null.

Throws:

IllegalArgumentException - if the given instance is null.

Since:

1.2

select

public <T>
ReactiveSelectOperation.ReactiveSelect<T> select(Class<T> domainType)

Description copied from interface: ReactiveSelectOperation

Begin creating a SELECT operation for the given domainType.

Specified by:

select in interface ReactiveSelectOperation

Type Parameters:

T - type of the application domain object.

Parameters:

domainType - type of the domain object to query; must not be null.

Returns:

new instance of ReactiveSelectOperation.ReactiveSelect.

See Also:

• ReactiveSelectOperation.ReactiveSelect

insert

public <T>
ReactiveInsertOperation.ReactiveInsert<T> insert(Class<T> domainType)

Description copied from interface: ReactiveInsertOperation

Begin creating an INSERT operation for given domainType.

Specified by:

insert in interface ReactiveInsertOperation

Type Parameters:

T - type of the application domain object.

Parameters:

domainType - type of the domain object to insert; must not be null.

Returns:

new instance of ReactiveInsertOperation.ReactiveInsert.

See Also:

• ReactiveInsertOperation.ReactiveInsert

update

public ReactiveUpdateOperation.ReactiveUpdate update(Class<?> domainType)

Description copied from interface: ReactiveUpdateOperation

Begin creating an UPDATE operation for the given domainType.

Specified by:

update in interface ReactiveUpdateOperation

Parameters:

domainType - type of domain object to update; must not be null.

Returns:

new instance of ReactiveUpdateOperation.ReactiveUpdate.

See Also:

• ReactiveUpdateOperation.ReactiveUpdate

delete

public ReactiveDeleteOperation.ReactiveDelete delete(Class<?> domainType)

Description copied from interface: ReactiveDeleteOperation

Begin creating a DELETE operation for the given domainType.

Specified by:

delete in interface ReactiveDeleteOperation

Parameters:

domainType - type of domain object to delete; must not be null.

Returns:

new instance of ReactiveDeleteOperation.ReactiveDelete.

See Also:

• ReactiveDeleteOperation.ReactiveDelete

count

public Mono<Long> count(org.springframework.data.relational.core.query.Query query,
 Class<?> entityClass)
                 throws DataAccessException

Description copied from interface: R2dbcEntityOperations

Returns the number of rows for the given entity class applying Query. This overridden method allows users to further refine the selection Query using a Query predicate to determine how many entities of the given type match the Query.

Specified by:

count in interface R2dbcEntityOperations

Parameters:

query - user-defined count Query to execute; must not be null.

entityClass - type of the entity; must not be null.

Returns:

the number of existing entities.

Throws:

DataAccessException - if any problem occurs while executing the query.

exists

public Mono<Boolean> exists(org.springframework.data.relational.core.query.Query query,
 Class<?> entityClass)
                     throws DataAccessException

Description copied from interface: R2dbcEntityOperations

Determine whether the result for entityClass Query yields at least one row.

Specified by:

exists in interface R2dbcEntityOperations

Parameters:

query - user-defined exists Query to execute; must not be null.

entityClass - type of the entity; must not be null.

Returns:

true if the object exists.

Throws:

DataAccessException - if any problem occurs while executing the query.

select

public <T> Flux<T> select(org.springframework.data.relational.core.query.Query query,
 Class<T> entityClass)
                   throws DataAccessException

Description copied from interface: R2dbcEntityOperations

Execute a SELECT query and convert the resulting items to a stream of entities.

Specified by:

select in interface R2dbcEntityOperations

Parameters:

query - must not be null.

entityClass - the entity type must not be null.

Returns:

the result objects returned by the action.

Throws:

DataAccessException - if there is any problem issuing the execution.

selectOne

public <T> Mono<T> selectOne(org.springframework.data.relational.core.query.Query query,
 Class<T> entityClass)
                      throws DataAccessException

Description copied from interface: R2dbcEntityOperations

Execute a SELECT query and convert the resulting item to an entity ensuring exactly one result.

Specified by:

selectOne in interface R2dbcEntityOperations

Parameters:

query - must not be null.

entityClass - the entity type must not be null.

Returns:

exactly one result or Mono.empty() if no match found.

Throws:

IncorrectResultSizeDataAccessException - if more than one match found.

DataAccessException - if there is any problem issuing the execution.

update

public Mono<Long> update(org.springframework.data.relational.core.query.Query query,
 org.springframework.data.relational.core.query.Update update,
 Class<?> entityClass)
                  throws DataAccessException

Description copied from interface: R2dbcEntityOperations

Update the queried entities and return true if the update was applied.

Specified by:

update in interface R2dbcEntityOperations

Parameters:

query - must not be null.

update - must not be null.

entityClass - the entity type must not be null.

Returns:

the number of affected rows.

Throws:

DataAccessException - if there is any problem executing the query.

delete

public Mono<Long> delete(org.springframework.data.relational.core.query.Query query,
 Class<?> entityClass)
                  throws DataAccessException

Description copied from interface: R2dbcEntityOperations

Remove entities (rows)/columns from the table by Query.

Specified by:

delete in interface R2dbcEntityOperations

Parameters:

query - must not be null.

entityClass - the entity type must not be null.

Returns:

the number of affected rows.

Throws:

DataAccessException - if there is any problem issuing the execution.

query

public <T> RowsFetchSpec<T> query(PreparedOperation<?> operation,
 Class<T> entityClass)

Description copied from interface: R2dbcEntityOperations

Execute a query for a RowsFetchSpec, given PreparedOperation. Any provided bindings within PreparedOperation are applied to the underlying DatabaseClient. The query is issued as-is without additional pre-processing such as named parameter expansion. Results of the query are mapped onto entityClass.

Specified by:

query in interface R2dbcEntityOperations

Parameters:

operation - the prepared operation wrapping a SQL query and bind parameters.

entityClass - the entity type must not be null.

Returns:

a RowsFetchSpec ready to materialize.

query

public <T> RowsFetchSpec<T> query(PreparedOperation<?> operation,
 Class<?> entityClass,
 Class<T> resultType)
                           throws DataAccessException

Description copied from interface: R2dbcEntityOperations

Execute a query for a RowsFetchSpec, given PreparedOperation. Any provided bindings within PreparedOperation are applied to the underlying DatabaseClient. The query is issued as-is without additional pre-processing such as named parameter expansion. Results of the query are mapped onto entityClass.

Specified by:

query in interface R2dbcEntityOperations

Parameters:

operation - the prepared operation wrapping a SQL query and bind parameters.

entityClass - the entity type must not be null.

resultType - the returned entity, type must not be null.

Returns:

a RowsFetchSpec ready to materialize.

Throws:

DataAccessException - if there is any problem issuing the execution.

query

public <T> RowsFetchSpec<T> query(PreparedOperation<?> operation,
 BiFunction<Row,RowMetadata,T> rowMapper)

Description copied from interface: R2dbcEntityOperations

Execute a query for a RowsFetchSpec, given PreparedOperation. Any provided bindings within PreparedOperation are applied to the underlying DatabaseClient. The query is issued as-is without additional pre-processing such as named parameter expansion. Results of the query are mapped using rowMapper.

Specified by:

query in interface R2dbcEntityOperations

Parameters:

operation - the prepared operation wrapping a SQL query and bind parameters.

rowMapper - the row mapper must not be null.

Returns:

a RowsFetchSpec with rowMapper applied ready to materialize.

query

public <T> RowsFetchSpec<T> query(PreparedOperation<?> operation,
 Class<?> entityClass,
 BiFunction<Row,RowMetadata,T> rowMapper)

Description copied from interface: R2dbcEntityOperations

Execute a query for a RowsFetchSpec in the context of entityClass, given PreparedOperation. Any provided bindings within PreparedOperation are applied to the underlying DatabaseClient. The query is issued as-is without additional pre-processing such as named parameter expansion. Results of the query are mapped using rowMapper.

Specified by:

query in interface R2dbcEntityOperations

Parameters:

operation - the prepared operation wrapping a SQL query and bind parameters.

entityClass - the entity type must not be null.

rowMapper - the row mapper must not be null.

Returns:

a RowsFetchSpec with rowMapper applied ready to materialize.

See Also:

• R2dbcEntityOperations.query(PreparedOperation, Class, BiFunction)

insert

public <T> Mono<T> insert(T entity)
                   throws DataAccessException

Description copied from interface: R2dbcEntityOperations

Insert the given entity and emit the entity if the insert was applied.

Specified by:

insert in interface R2dbcEntityOperations

Parameters:

entity - the entity to insert, must not be null.

Returns:

the inserted entity.

Throws:

DataAccessException - if there is any problem issuing the execution.

update

public <T> Mono<T> update(T entity)
                   throws DataAccessException

Description copied from interface: R2dbcEntityOperations

Update the given entity and emit the entity if the update was applied.

Specified by:

update in interface R2dbcEntityOperations

Parameters:

entity - the entity to update, must not be null.

Returns:

the updated entity.

Throws:

DataAccessException - if there is any problem issuing the execution.

TransientDataAccessResourceException - if the update did not affect any rows.

delete

public <T> Mono<T> delete(T entity)
                   throws DataAccessException

Description copied from interface: R2dbcEntityOperations

Delete the given entity and emit the entity if the delete was applied.

Specified by:

delete in interface R2dbcEntityOperations

Parameters:

entity - must not be null.

Returns:

the deleted entity.

Throws:

DataAccessException - if there is any problem issuing the execution.

maybeCallBeforeConvert

protected <T> Mono<T> maybeCallBeforeConvert(T object,
 org.springframework.data.relational.core.sql.SqlIdentifier table)

maybeCallBeforeSave

protected <T> Mono<T> maybeCallBeforeSave(T object,
 OutboundRow row,
 org.springframework.data.relational.core.sql.SqlIdentifier table)

maybeCallAfterSave

protected <T> Mono<T> maybeCallAfterSave(T object,
 OutboundRow row,
 org.springframework.data.relational.core.sql.SqlIdentifier table)

maybeCallAfterConvert

protected <T> Mono<T> maybeCallAfterConvert(T object,
 org.springframework.data.relational.core.sql.SqlIdentifier table)

getRowsFetchSpec

public <T> RowsFetchSpec<T> getRowsFetchSpec(DatabaseClient.GenericExecuteSpec executeSpec,
 Class<?> entityType,
 Class<T> resultType)

Specified by:

getRowsFetchSpec in interface R2dbcEntityOperations