Module spring.data.r2dbc

Package org.springframework.data.r2dbc.core

Interface StatementMapper

All Known Subinterfaces:

StatementMapper.TypedStatementMapper<T>

public interface StatementMapper

Mapper for statement specifications to PreparedOperation. Statement mapping applies a R2dbcDialect-specific transformation considering BindMarkers and vendor-specific SQL differences.

Mapped statements can be used directly with DatabaseClient.sql(Supplier) without specifying further SQL or bindings as the prepared operation encapsulates the specified SQL operation.

Author:

Mark Paluch, Roman Chigvintsev, Mingyuan Wu, Diego Krupitza

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	StatementMapper.DeleteSpec	DELETE specification.
static class	StatementMapper.InsertSpec	INSERT specification.
static class	StatementMapper.SelectSpec	SELECT specification.
static interface	StatementMapper.TypedStatementMapper<T>	Extension to StatementMapper that is associated with a type.
static class	StatementMapper.UpdateSpec	UPDATE specification.

Method Summary

Modifier and Type	Method	Description
static StatementMapper	create(R2dbcDialect dialect, R2dbcConverter converter)	Create a new StatementMapper given R2dbcDialect and R2dbcConverter.
default StatementMapper.DeleteSpec	createDelete(String table)	Create a DELETE specification for table.
default StatementMapper.DeleteSpec	createDelete(org.springframework.data.relational.core.sql.SqlIdentifier table)	Create a DELETE specification for table.
default StatementMapper.InsertSpec	createInsert(String table)	Create an INSERT specification for table.
default StatementMapper.InsertSpec	createInsert(org.springframework.data.relational.core.sql.SqlIdentifier table)	Create an INSERT specification for table.
default StatementMapper.SelectSpec	createSelect(String table)	Create a SELECT specification for table.
default StatementMapper.SelectSpec	createSelect(org.springframework.data.relational.core.sql.SqlIdentifier table)	Create a SELECT specification for table.
default StatementMapper.UpdateSpec	createUpdate(String table, org.springframework.data.relational.core.query.Update update)	Create an UPDATE specification for table.
default StatementMapper.UpdateSpec	createUpdate(org.springframework.data.relational.core.sql.SqlIdentifier table, org.springframework.data.relational.core.query.Update update)	Create an UPDATE specification for table.
<T> StatementMapper.TypedStatementMapper<T>	forType(Class<T> type)	Create a typed StatementMapper that considers type-specific mapping metadata.
PreparedOperation<?>	getMappedObject(StatementMapper.DeleteSpec deleteSpec)	Map a delete specification to a PreparedOperation.
PreparedOperation<?>	getMappedObject(StatementMapper.InsertSpec insertSpec)	Map a insert specification to a PreparedOperation.
PreparedOperation<?>	getMappedObject(StatementMapper.SelectSpec selectSpec)	Map a select specification to a PreparedOperation.
PreparedOperation<?>	getMappedObject(StatementMapper.UpdateSpec updateSpec)	Map a update specification to a PreparedOperation.
default org.springframework.data.relational.core.sql.render.RenderContext	getRenderContext()	Returns RenderContext.

Method Details

create

static StatementMapper create(R2dbcDialect dialect,
 R2dbcConverter converter)

Create a new StatementMapper given R2dbcDialect and R2dbcConverter.

Parameters:

dialect - must not be null.

converter - must not be null.

Returns:

the new StatementMapper.

Since:

1.2

forType

<T> StatementMapper.TypedStatementMapper<T> forType(Class<T> type)

Create a typed StatementMapper that considers type-specific mapping metadata.

Type Parameters:

T -

Parameters:

type - must not be null.

Returns:

the typed StatementMapper.

getMappedObject

PreparedOperation<?> getMappedObject(StatementMapper.SelectSpec selectSpec)

Map a select specification to a PreparedOperation.

Parameters:

selectSpec - the insert operation definition, must not be null.

Returns:

the PreparedOperation for StatementMapper.SelectSpec.

getMappedObject

PreparedOperation<?> getMappedObject(StatementMapper.InsertSpec insertSpec)

Map a insert specification to a PreparedOperation.

Parameters:

insertSpec - the insert operation definition, must not be null.

Returns:

the PreparedOperation for StatementMapper.InsertSpec.

getMappedObject

PreparedOperation<?> getMappedObject(StatementMapper.UpdateSpec updateSpec)

Map a update specification to a PreparedOperation.

Parameters:

updateSpec - the update operation definition, must not be null.

Returns:

the PreparedOperation for StatementMapper.UpdateSpec.

getMappedObject

PreparedOperation<?> getMappedObject(StatementMapper.DeleteSpec deleteSpec)

Map a delete specification to a PreparedOperation.

Parameters:

deleteSpec - the update operation definition, must not be null.

Returns:

the PreparedOperation for StatementMapper.DeleteSpec.

createSelect

default StatementMapper.SelectSpec createSelect(String table)

Create a SELECT specification for table.

Parameters:

table -

Returns:

the StatementMapper.SelectSpec.

createSelect

default StatementMapper.SelectSpec createSelect(org.springframework.data.relational.core.sql.SqlIdentifier table)

Create a SELECT specification for table.

Parameters:

table -

Returns:

the StatementMapper.SelectSpec.

Since:

1.1

createInsert

default StatementMapper.InsertSpec createInsert(String table)

Create an INSERT specification for table.

Parameters:

table -

Returns:

the StatementMapper.InsertSpec.

createInsert

default StatementMapper.InsertSpec createInsert(org.springframework.data.relational.core.sql.SqlIdentifier table)

Create an INSERT specification for table.

Parameters:

table -

Returns:

the StatementMapper.InsertSpec.

Since:

1.1

createUpdate

default StatementMapper.UpdateSpec createUpdate(String table,
 org.springframework.data.relational.core.query.Update update)

Create an UPDATE specification for table.

Parameters:

table -

Returns:

the StatementMapper.UpdateSpec.

createUpdate

default StatementMapper.UpdateSpec createUpdate(org.springframework.data.relational.core.sql.SqlIdentifier table,
 org.springframework.data.relational.core.query.Update update)

Create an UPDATE specification for table.

Parameters:

table -

Returns:

the StatementMapper.UpdateSpec.

Since:

1.1

createDelete

default StatementMapper.DeleteSpec createDelete(String table)

Create a DELETE specification for table.

Parameters:

table -

Returns:

the StatementMapper.DeleteSpec.

createDelete

default StatementMapper.DeleteSpec createDelete(org.springframework.data.relational.core.sql.SqlIdentifier table)

Create a DELETE specification for table.

Parameters:

table -

Returns:

the StatementMapper.DeleteSpec.

Since:

1.1

getRenderContext

@Nullable
default org.springframework.data.relational.core.sql.render.RenderContext getRenderContext()

Returns RenderContext.

Returns:

RenderContext instance or null if RenderContext is not available