io.micronaut.data.jdbc.operations

Class AbstractSqlRepositoryOperations<RS,PS>

java.lang.Object

io.micronaut.data.jdbc.operations.AbstractSqlRepositoryOperations<RS,PS>

Type Parameters:

RS - The result set type

PS - The prepared statement type

All Implemented Interfaces:

RepositoryOperations

Direct Known Subclasses:

DefaultJdbcRepositoryOperations

public abstract class AbstractSqlRepositoryOperations<RS,PS>
extends java.lang.Object
implements RepositoryOperations

Abstract SQL repository implementation not specifically bound to JDBC.

Since:

1.0.0

Author:

graemerocher

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	AbstractSqlRepositoryOperations.StatementSupplier<PS> Functional interface used to supply a statement.
protected class	AbstractSqlRepositoryOperations.StoredInsert<T> A stored insert statement.

Field Summary

Fields

Modifier and Type	Field and Description
protected ResultReader<RS,java.lang.Integer>	columnIndexResultSetReader
protected ResultReader<RS,java.lang.String>	columnNameResultSetReader
protected DateTimeProvider	dateTimeProvider
protected static SqlQueryBuilder	DEFAULT_SQL_BUILDER
protected EntityEventListener<java.lang.Object>	entityEventRegistry
protected io.micronaut.http.codec.MediaTypeCodec	jsonCodec
protected QueryStatement<PS,java.lang.Integer>	preparedStatementWriter
protected static org.slf4j.Logger	QUERY_LOG
protected java.util.Map<java.lang.Class,SqlQueryBuilder>	queryBuilders

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractSqlRepositoryOperations(java.lang.String dataSourceName, ResultReader<RS,java.lang.String> columnNameResultSetReader, ResultReader<RS,java.lang.Integer> columnIndexResultSetReader, QueryStatement<PS,java.lang.Integer> preparedStatementWriter, java.util.List<io.micronaut.http.codec.MediaTypeCodec> codecs, DateTimeProvider<java.lang.Object> dateTimeProvider, io.micronaut.context.BeanContext beanContext) Deprecated. Use AbstractSqlRepositoryOperations(String, ResultReader, ResultReader, QueryStatement, List, DateTimeProvider, RuntimeEntityRegistry, BeanContext)
protected	AbstractSqlRepositoryOperations(java.lang.String dataSourceName, ResultReader<RS,java.lang.String> columnNameResultSetReader, ResultReader<RS,java.lang.Integer> columnIndexResultSetReader, QueryStatement<PS,java.lang.Integer> preparedStatementWriter, java.util.List<io.micronaut.http.codec.MediaTypeCodec> codecs, DateTimeProvider<java.lang.Object> dateTimeProvider, RuntimeEntityRegistry runtimeEntityRegistry, io.micronaut.context.BeanContext beanContext) Default constructor.

Method Summary

Modifier and Type	Method and Description
<T> RuntimePersistentEntity<T>	getEntity(java.lang.Class<T> type) Retrieves the entity for the given type.
protected RuntimePersistentProperty<java.lang.Object>	getIdReader(java.lang.Object o) Obtain an ID reader for the given object.
protected boolean	isSqlServerWithoutOrderBy(java.lang.String query, Dialect dialect) In the dialect SQL server and is order by required.
protected <T,R> PS	prepareStatement(AbstractSqlRepositoryOperations.StatementSupplier<PS> statementFunction, PreparedQuery<T,R> preparedQuery, boolean isUpdate, boolean isSingleResult) Prepare a statement for execution.
protected <T> java.lang.String	resolveAssociationInsert(java.lang.Class repositoryType, RuntimePersistentEntity<T> persistentEntity, RuntimeAssociation<T> association) Builds a join table insert.
protected <T> AbstractSqlRepositoryOperations.StoredInsert<T>	resolveEntityInsert(io.micronaut.core.annotation.AnnotationMetadata annotationMetadata, java.lang.Class<?> repositoryType, java.lang.Class<?> rootEntity, RuntimePersistentEntity<?> persistentEntity) Resolves a stored insert for the given entity.
protected <T> AbstractSqlRepositoryOperations.StoredInsert<T>	resolveEntityUpdate(io.micronaut.core.annotation.AnnotationMetadata annotationMetadata, java.lang.Class<?> repositoryType, java.lang.Class<?> rootEntity, RuntimePersistentEntity<?> persistentEntity) Resolves a stored update for the given entity.
protected <T> AbstractSqlRepositoryOperations.StoredInsert<T>	resolveInsert(EntityOperation<T> operation) Resolve the INSERT for the given EntityOperation.
protected <T> void	setInsertParameters(AbstractSqlRepositoryOperations.StoredInsert<T> insert, T entity, PS stmt) Sets the insert parameters for the given insert, entity and statement.
protected void	setStatementParameter(PS preparedStatement, int index, DataType dataType, java.lang.Object value, Dialect dialect) Set the parameter value on the given statement.
protected int	shiftIndex(int i) Used to define the index whether it is 1 based (JDBC) or 0 based (R2DBC).
protected int	sizeOf(java.lang.Object value) Compute the size of the given object.
protected <T> Sort	sortById(RuntimePersistentEntity<T> persistentEntity) Build a sort for ID for the given entity.
protected <T> T	triggerPostLoad(T entity, RuntimePersistentEntity<T> pe, io.micronaut.core.annotation.AnnotationMetadata annotationMetadata) Trigger the post load event.
protected <T> T	triggerPostPersist(T entity, RuntimePersistentEntity<T> pe, io.micronaut.core.annotation.AnnotationMetadata annotationMetadata) Trigger the post persist event.
protected <T> void	triggerPostRemove(T entity, RuntimePersistentEntity<T> pe, io.micronaut.core.annotation.AnnotationMetadata annotationMetadata) Trigger the post remove event.
protected <T> void	triggerPostUpdate(T entity, RuntimePersistentEntity<T> pe, io.micronaut.core.annotation.AnnotationMetadata annotationMetadata) Trigger the post update event.
protected <T> T	triggerPrePersist(T entity, RuntimePersistentEntity<T> pe, io.micronaut.core.annotation.AnnotationMetadata annotationMetadata) Trigger the pre persist event.
protected <T> T	triggerPreRemove(T entity, RuntimePersistentEntity<T> pe, io.micronaut.core.annotation.AnnotationMetadata annotationMetadata) Trigger the pre remove event.
protected <T> T	triggerPreUpdate(T entity, RuntimePersistentEntity<T> pe, io.micronaut.core.annotation.AnnotationMetadata annotationMetadata) Trigger the pre update event.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.data.operations.RepositoryOperations

count, delete, deleteAll, executeDelete, executeUpdate, exists, findAll, findAll, findOne, findOne, findPage, findStream, findStream, getQueryHints, persist, persistAll, update

Field Detail

QUERY_LOG

protected static final org.slf4j.Logger QUERY_LOG

DEFAULT_SQL_BUILDER

protected static final SqlQueryBuilder DEFAULT_SQL_BUILDER

columnNameResultSetReader

protected final ResultReader<RS,java.lang.String> columnNameResultSetReader

columnIndexResultSetReader

protected final ResultReader<RS,java.lang.Integer> columnIndexResultSetReader

preparedStatementWriter

protected final QueryStatement<PS,java.lang.Integer> preparedStatementWriter

queryBuilders

protected final java.util.Map<java.lang.Class,SqlQueryBuilder> queryBuilders

jsonCodec

protected final io.micronaut.http.codec.MediaTypeCodec jsonCodec

entityEventRegistry

protected final EntityEventListener<java.lang.Object> entityEventRegistry

dateTimeProvider

protected final DateTimeProvider dateTimeProvider

Constructor Detail

AbstractSqlRepositoryOperations

@Deprecated
protected AbstractSqlRepositoryOperations(java.lang.String dataSourceName,
                                                      ResultReader<RS,java.lang.String> columnNameResultSetReader,
                                                      ResultReader<RS,java.lang.Integer> columnIndexResultSetReader,
                                                      QueryStatement<PS,java.lang.Integer> preparedStatementWriter,
                                                      java.util.List<io.micronaut.http.codec.MediaTypeCodec> codecs,
                                                      DateTimeProvider<java.lang.Object> dateTimeProvider,
                                                      io.micronaut.context.BeanContext beanContext)

Deprecated. Use AbstractSqlRepositoryOperations(String, ResultReader, ResultReader, QueryStatement, List, DateTimeProvider, RuntimeEntityRegistry, BeanContext)

Default constructor.

Parameters:

dataSourceName - The datasource name

columnNameResultSetReader - The column name result reader

columnIndexResultSetReader - The column index result reader

preparedStatementWriter - The prepared statement writer

codecs - The media type codecs

dateTimeProvider - The date time provider

beanContext - The bean context

AbstractSqlRepositoryOperations

protected AbstractSqlRepositoryOperations(java.lang.String dataSourceName,
                                          ResultReader<RS,java.lang.String> columnNameResultSetReader,
                                          ResultReader<RS,java.lang.Integer> columnIndexResultSetReader,
                                          QueryStatement<PS,java.lang.Integer> preparedStatementWriter,
                                          java.util.List<io.micronaut.http.codec.MediaTypeCodec> codecs,
                                          DateTimeProvider<java.lang.Object> dateTimeProvider,
                                          RuntimeEntityRegistry runtimeEntityRegistry,
                                          io.micronaut.context.BeanContext beanContext)

Default constructor.

Parameters:

dataSourceName - The datasource name

columnNameResultSetReader - The column name result reader

columnIndexResultSetReader - The column index result reader

preparedStatementWriter - The prepared statement writer

codecs - The media type codecs

dateTimeProvider - The date time provider

runtimeEntityRegistry - The entity registry

beanContext - The bean context

Method Detail

getEntity

@NonNull
public final <T> RuntimePersistentEntity<T> getEntity(@NonNull
                                                               java.lang.Class<T> type)

Description copied from interface: RepositoryOperations

Retrieves the entity for the given type.

Specified by:

getEntity in interface RepositoryOperations

Type Parameters:

T - The generic Type

Parameters:

type - The type

Returns:

The entity

prepareStatement

protected <T,R> PS prepareStatement(AbstractSqlRepositoryOperations.StatementSupplier<PS> statementFunction,
                                    @NonNull
                                    PreparedQuery<T,R> preparedQuery,
                                    boolean isUpdate,
                                    boolean isSingleResult)

Prepare a statement for execution.

Type Parameters:

T - The query declaring type

R - The query result type

Parameters:

statementFunction - The statement function

preparedQuery - The prepared query

isUpdate - Is this an update

isSingleResult - Is it a single result

Returns:

The prepared statement

setInsertParameters

protected final <T> void setInsertParameters(@NonNull
                                             AbstractSqlRepositoryOperations.StoredInsert<T> insert,
                                             @NonNull
                                             T entity,
                                             @NonNull
                                             PS stmt)

Sets the insert parameters for the given insert, entity and statement.

Type Parameters:

T - The entity type

Parameters:

insert - The insert

entity - The entity

stmt - The statement

triggerPrePersist

protected <T> T triggerPrePersist(@NonNull
                                  T entity,
                                  RuntimePersistentEntity<T> pe,
                                  io.micronaut.core.annotation.AnnotationMetadata annotationMetadata)

Trigger the pre persist event.

Type Parameters:

T - The generic type

Parameters:

entity - The entity

pe - The persistent entity

annotationMetadata - The annotation metadata

Returns:

The entity or null if the operation was vetoed

triggerPostPersist

protected <T> T triggerPostPersist(@NonNull
                                   T entity,
                                   RuntimePersistentEntity<T> pe,
                                   io.micronaut.core.annotation.AnnotationMetadata annotationMetadata)

Trigger the post persist event.

Type Parameters:

T - The generic type

Parameters:

entity - The entity

pe - The persistent entity

annotationMetadata - The annotation metadata

Returns:

The entity possibly modified

triggerPreRemove

protected <T> T triggerPreRemove(@NonNull
                                 T entity,
                                 RuntimePersistentEntity<T> pe,
                                 io.micronaut.core.annotation.AnnotationMetadata annotationMetadata)

Trigger the pre remove event.

Type Parameters:

T - The generic type

Parameters:

entity - The entity

pe - The persistent entity

annotationMetadata - The annotation metadata

Returns:

The entity or null if the operation was vetoed

triggerPostRemove

protected <T> void triggerPostRemove(@NonNull
                                     T entity,
                                     RuntimePersistentEntity<T> pe,
                                     io.micronaut.core.annotation.AnnotationMetadata annotationMetadata)

Trigger the post remove event.

Type Parameters:

T - The generic type

Parameters:

entity - The entity

pe - The persistent entity

annotationMetadata - The annotation metadata

triggerPreUpdate

protected <T> T triggerPreUpdate(@NonNull
                                 T entity,
                                 RuntimePersistentEntity<T> pe,
                                 io.micronaut.core.annotation.AnnotationMetadata annotationMetadata)

Trigger the pre update event.

Type Parameters:

T - The generic type

Parameters:

entity - The entity

pe - The persistent entity

annotationMetadata - The annotation metadata

Returns:

The entity or null if the operation was vetoed

triggerPostUpdate

protected <T> void triggerPostUpdate(@NonNull
                                     T entity,
                                     RuntimePersistentEntity<T> pe,
                                     io.micronaut.core.annotation.AnnotationMetadata annotationMetadata)

Trigger the post update event.

Type Parameters:

T - The generic type

Parameters:

entity - The entity

pe - The persistent entity

annotationMetadata - The annotation metadata

triggerPostLoad

protected <T> T triggerPostLoad(@NonNull
                                T entity,
                                RuntimePersistentEntity<T> pe,
                                io.micronaut.core.annotation.AnnotationMetadata annotationMetadata)

Trigger the post load event.

Type Parameters:

T - The generic type

Parameters:

entity - The entity

pe - The persistent entity

annotationMetadata - The annotation metadata

Returns:

The entity, possibly modified

shiftIndex

protected int shiftIndex(int i)

Used to define the index whether it is 1 based (JDBC) or 0 based (R2DBC).

Parameters:

i - The index to shift

Returns:

the index

resolveInsert

@NonNull
protected final <T> AbstractSqlRepositoryOperations.StoredInsert<T> resolveInsert(@NonNull
                                                                                           EntityOperation<T> operation)

Resolve the INSERT for the given EntityOperation.

Type Parameters:

T - The entity type

Parameters:

operation - The operation

Returns:

The insert

getIdReader

@NonNull
protected final RuntimePersistentProperty<java.lang.Object> getIdReader(@NonNull
                                                                                 java.lang.Object o)

Obtain an ID reader for the given object.

Parameters:

o - The object

Returns:

The ID reader

sortById

@NonNull
protected final <T> Sort sortById(RuntimePersistentEntity<T> persistentEntity)

Build a sort for ID for the given entity.

Type Parameters:

T - The entity type

Parameters:

persistentEntity - The entity

Returns:

The sort

isSqlServerWithoutOrderBy

protected final boolean isSqlServerWithoutOrderBy(java.lang.String query,
                                                  Dialect dialect)

In the dialect SQL server and is order by required.

Parameters:

query - The query

dialect - The dialect

Returns:

True if it is

sizeOf

protected final int sizeOf(java.lang.Object value)

Compute the size of the given object.

Parameters:

value - The value

Returns:

The size

setStatementParameter

protected final void setStatementParameter(PS preparedStatement,
                                           int index,
                                           DataType dataType,
                                           java.lang.Object value,
                                           Dialect dialect)

Set the parameter value on the given statement.

Parameters:

preparedStatement - The prepared statement

index - The index

dataType - The data type

value - The value

dialect - The dialect

resolveEntityInsert

@NonNull
protected <T> AbstractSqlRepositoryOperations.StoredInsert<T> resolveEntityInsert(io.micronaut.core.annotation.AnnotationMetadata annotationMetadata,
                                                                                           java.lang.Class<?> repositoryType,
                                                                                           @NonNull
                                                                                           java.lang.Class<?> rootEntity,
                                                                                           @NonNull
                                                                                           RuntimePersistentEntity<?> persistentEntity)

Resolves a stored insert for the given entity.

Type Parameters:

T - The generic type

Parameters:

annotationMetadata - The repository annotation metadata

repositoryType - The repository type

rootEntity - The root entity

persistentEntity - The persistent entity

Returns:

The insert

resolveEntityUpdate

@NonNull
protected <T> AbstractSqlRepositoryOperations.StoredInsert<T> resolveEntityUpdate(io.micronaut.core.annotation.AnnotationMetadata annotationMetadata,
                                                                                           java.lang.Class<?> repositoryType,
                                                                                           @NonNull
                                                                                           java.lang.Class<?> rootEntity,
                                                                                           @NonNull
                                                                                           RuntimePersistentEntity<?> persistentEntity)

Resolves a stored update for the given entity.

Type Parameters:

T - The generic type

Parameters:

annotationMetadata - The repository annotation metadata

repositoryType - The repository type

rootEntity - The root entity

persistentEntity - The persistent entity

Returns:

The insert

resolveAssociationInsert

protected <T> java.lang.String resolveAssociationInsert(java.lang.Class repositoryType,
                                                        RuntimePersistentEntity<T> persistentEntity,
                                                        RuntimeAssociation<T> association)

Builds a join table insert.

Type Parameters:

T - The entity generic type

Parameters:

repositoryType - The repository type

persistentEntity - The entity

association - The association

Returns:

The insert statement