Package io.micronaut.data.runtime.operations.internal.sql

Class DefaultSqlPreparedQuery<E,R>

java.lang.Object

io.micronaut.data.runtime.operations.internal.query.DefaultBindableParametersPreparedQuery<E,R>

io.micronaut.data.runtime.operations.internal.sql.DefaultSqlPreparedQuery<E,R>

Type Parameters:

E - The entity type

R - The result type

All Implemented Interfaces:

io.micronaut.core.annotation.AnnotationMetadataProvider, io.micronaut.core.annotation.AnnotationSource, io.micronaut.core.attr.AttributeHolder, io.micronaut.core.convert.ConversionServiceProvider, io.micronaut.core.naming.Named, PagedQuery<E>, PreparedDataOperation<R>, PreparedQuery<E,R>, StoredDataOperation<R>, StoredQuery<E,R>, BindableParametersPreparedQuery<E,R>, BindableParametersStoredQuery<E,R>, PersistentEntityAwareQuery<E>, SqlPreparedQuery<E,R>, SqlStoredQuery<E,R>, DelegatePreparedQuery<E,R>, DelegateStoredQuery<E,R>

@Internal
public class DefaultSqlPreparedQuery<E,R>
extends DefaultBindableParametersPreparedQuery<E,R>
implements SqlPreparedQuery<E,R>, DelegatePreparedQuery<E,R>

Implementation of SqlPreparedQuery.

Since:

3.5.0

Author:

Denis Stepanov

Nested Class Summary

Nested classes/interfaces inherited from interface io.micronaut.data.runtime.operations.internal.query.BindableParametersStoredQuery

BindableParametersStoredQuery.Binder

Nested classes/interfaces inherited from interface io.micronaut.data.model.runtime.StoredQuery

StoredQuery.OperationType

Field Summary

Fields

Modifier and Type	Field	Description
protected @Nullable List<PersistentPropertyPath>	cursorProperties
protected @Nullable List<QueryParameterBinding>	cursorQueryBindings
protected String	query
protected final SqlStoredQuery<E,R>	sqlStoredQuery

Fields inherited from class io.micronaut.data.runtime.operations.internal.query.DefaultBindableParametersPreparedQuery

invocationContext, preparedQuery, storedQuery

Fields inherited from interface io.micronaut.core.annotation.AnnotationSource

EMPTY

Constructor Summary

Constructors

Constructor	Description
DefaultSqlPreparedQuery(PreparedQuery<E,R> preparedQuery)
DefaultSqlPreparedQuery(PreparedQuery<E,R> preparedQuery, SqlStoredQuery<E,R> sqlStoredQuery)
DefaultSqlPreparedQuery(SqlStoredQuery<E,R> sqlStoredQuery)

Method Summary

Modifier and Type	Method	Description
void	attachPageable(Pageable pageable, Limit limit, Sort sort)	Modify the query according to the pageable.
void	bindParameters(BindableParametersStoredQuery.Binder binder, @Nullable E entity, @Nullable Map<QueryParameterBinding,Object> previousValues)	Bind query parameters.
@Nullable Map<QueryParameterBinding,Object>	collectAutoPopulatedPreviousValues(E entity)	Collect auto-populated property values before pre-actions are triggered and property values are modified.
@Nullable List<Pageable.Cursor>	createCursors(List<Object> results, Pageable pageable)	Modify pageable based on the scan results.
@Nullable List<Pageable.Cursor>	createCursors(List<Object> results, Pageable pageable, RuntimePersistentEntity<Object> runtimePersistentEntity)	Modify pageable based on the scan results.
static Sort	enhanceCursoredSort(Sort sort, boolean isBackwards, PersistentEntity persistentEntity)
static CursoredPageable	enhancePageable(CursoredPageable cursored, PersistentEntity persistentEntity)
Dialect	getDialect()	Get dialect.
@Nullable io.micronaut.aop.InvocationContext<?,?>	getInvocationContext()	Returns the invocation context associated with this prepared query.
RuntimePersistentEntity<E>	getPersistentEntity()
PreparedQuery<E,R>	getPreparedQueryDelegate()
String	getQuery()	The query to execute.
SqlQueryBuilder	getQueryBuilder()
protected int	getQueryParameterValueSize(QueryParameterBinding parameter)	Gets number of parameter values for the query parameter binding (used for IN for example).
@Nullable QueryResultInfo	getQueryResultInfo()
boolean	isExpandableQuery()
void	prepare(@Nullable E entity)	Check if query need to be modified to expand parameters.
protected int	sizeOf(@Nullable Object value)	Compute the size of the given object.

Methods inherited from class io.micronaut.data.runtime.operations.internal.query.DefaultBindableParametersPreparedQuery

bindParameters, bindParameters, getConversionService, getQueryLimit, getSort

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.core.annotation.AnnotationMetadataProvider

findAnnotation, findAnnotation, findDeclaredAnnotation, findDeclaredAnnotation, getTargetAnnotationMetadata, isAnnotationPresent, isDeclaredAnnotationPresent, synthesize, synthesizeAll, synthesizeAnnotationsByType, synthesizeDeclared, synthesizeDeclared, synthesizeDeclaredAnnotationsByType

Methods inherited from interface io.micronaut.core.annotation.AnnotationSource

getAnnotation, getAnnotation, getDeclaredAnnotation, getDeclaredAnnotation, isAnnotationPresent, isDeclaredAnnotationPresent, synthesize, synthesizeDeclared

Methods inherited from interface io.micronaut.data.runtime.operations.internal.query.BindableParametersPreparedQuery

bindParameters

Methods inherited from interface io.micronaut.data.runtime.operations.internal.query.BindableParametersStoredQuery

bindParameters

Methods inherited from interface io.micronaut.data.runtime.query.internal.DelegatePreparedQuery

getArguments, getAttribute, getAttribute, getAttributes, getConversionService, getPageable, getParameterArray, getParameterInRole, getParametersInRole, getQueryHints, getQueryLimit, getRepositoryType, getRootEntity, getSort, getStoredQueryDelegate, isDtoProjection, isRawQuery

Methods inherited from interface io.micronaut.data.runtime.query.internal.DelegateStoredQuery

getAnnotationMetadata, getExpandableQueryParts, getJoinPaths, getName, getOperationType, getParameterExpressions, getQueryBindings, getResultArgument, getResultDataType, getResultType, hasPageable, hasResultConsumer, isCount, isJsonEntity, isNative, isOptimisticLock, isProcedure

Methods inherited from interface io.micronaut.data.runtime.operations.internal.sql.SqlPreparedQuery

attachPageable

Field Details

cursorQueryBindings

protected @Nullable List<QueryParameterBinding> cursorQueryBindings

cursorProperties

protected @Nullable List<PersistentPropertyPath> cursorProperties

sqlStoredQuery

protected final SqlStoredQuery<E,R> sqlStoredQuery

query

protected String query

Constructor Details

DefaultSqlPreparedQuery

public DefaultSqlPreparedQuery(PreparedQuery<E,R> preparedQuery)

DefaultSqlPreparedQuery

public DefaultSqlPreparedQuery(PreparedQuery<E,R> preparedQuery,
 SqlStoredQuery<E,R> sqlStoredQuery)

DefaultSqlPreparedQuery

public DefaultSqlPreparedQuery(SqlStoredQuery<E,R> sqlStoredQuery)

Method Details

getPersistentEntity

public RuntimePersistentEntity<E> getPersistentEntity()

Specified by:

getPersistentEntity in interface PersistentEntityAwareQuery<E>

Specified by:

getPersistentEntity in interface SqlPreparedQuery<E,R>

Overrides:

getPersistentEntity in class DefaultBindableParametersPreparedQuery<E,R>

Returns:

The persistent entity

getPreparedQueryDelegate

public PreparedQuery<E,R> getPreparedQueryDelegate()

Specified by:

getPreparedQueryDelegate in interface DelegatePreparedQuery<E,R>

Overrides:

getPreparedQueryDelegate in class DefaultBindableParametersPreparedQuery<E,R>

Returns:

The delegate

isExpandableQuery

public boolean isExpandableQuery()

Specified by:

isExpandableQuery in interface SqlStoredQuery<E,R>

Returns:

true if query is expandable

getDialect

public Dialect getDialect()

Description copied from interface: SqlStoredQuery

Get dialect.

Specified by:

getDialect in interface SqlStoredQuery<E,R>

Returns:

dialect

getQueryBuilder

public SqlQueryBuilder getQueryBuilder()

Specified by:

getQueryBuilder in interface SqlStoredQuery<E,R>

Returns:

query builder for possible modification in the prepared query

getQuery

public String getQuery()

Description copied from interface: StoredQuery

The query to execute.

Specified by:

getQuery in interface DelegatePreparedQuery<E,R>

Specified by:

getQuery in interface DelegateStoredQuery<E,R>

Specified by:

getQuery in interface StoredQuery<E,R>

Returns:

The query to execute

collectAutoPopulatedPreviousValues

public @Nullable Map<QueryParameterBinding,Object> collectAutoPopulatedPreviousValues(E entity)

Description copied from interface: SqlStoredQuery

Collect auto-populated property values before pre-actions are triggered and property values are modified.

Specified by:

collectAutoPopulatedPreviousValues in interface SqlStoredQuery<E,R>

Parameters:

entity - The entity instance

Returns:

collected values

prepare

public void prepare(@Nullable E entity)

Check if query need to be modified to expand parameters.

Specified by:

prepare in interface SqlPreparedQuery<E,R>

Parameters:

entity - The entity instance

getQueryParameterValueSize

protected int getQueryParameterValueSize(QueryParameterBinding parameter)

Gets number of parameter values for the query parameter binding (used for IN for example).

Parameters:

parameter - the query binding parameter

Returns:

number of parameter values in query parameter binding

enhanceCursoredSort

public static Sort enhanceCursoredSort(Sort sort,
 boolean isBackwards,
 PersistentEntity persistentEntity)

enhancePageable

public static CursoredPageable enhancePageable(CursoredPageable cursored,
 PersistentEntity persistentEntity)

attachPageable

public void attachPageable(Pageable pageable,
 Limit limit,
 Sort sort)

Description copied from interface: SqlPreparedQuery

Modify the query according to the pageable.

Specified by:

attachPageable in interface SqlPreparedQuery<E,R>

Parameters:

pageable - The pageable

limit - The limit

sort - The sort

createCursors

@Internal
public @Nullable List<Pageable.Cursor> createCursors(List<Object> results,
 Pageable pageable)

Modify pageable based on the scan results. This is required for cursored pageable, as cursor is created from the results.

Parameters:

results - The scanning results

pageable - The pageable sent by user

Returns:

The updated pageable

Since:

4.8.0

createCursors

@Internal
public @Nullable List<Pageable.Cursor> createCursors(List<Object> results,
 Pageable pageable,
 RuntimePersistentEntity<Object> runtimePersistentEntity)

Modify pageable based on the scan results. This is required for cursored pageable, as cursor is created from the results.

Parameters:

results - The scanning results

pageable - The pageable sent by user

runtimePersistentEntity - The runtime persistent entity. Actual repository persistent entity type or custom runtime persistent entity in case of DTO projection.

Returns:

The updated pageable

Since:

4.8.0

bindParameters

public void bindParameters(BindableParametersStoredQuery.Binder binder,
 @Nullable E entity,
 @Nullable Map<QueryParameterBinding,Object> previousValues)

Description copied from interface: BindableParametersPreparedQuery

Bind query parameters.

Specified by:

bindParameters in interface BindableParametersPreparedQuery<E,R>

Overrides:

bindParameters in class DefaultBindableParametersPreparedQuery<E,R>

Parameters:

binder - The binder

entity - The entity

previousValues - The previous auto-populated collected values

getQueryResultInfo

public @Nullable QueryResultInfo getQueryResultInfo()

Specified by:

getQueryResultInfo in interface SqlPreparedQuery<E,R>

Specified by:

getQueryResultInfo in interface SqlStoredQuery<E,R>

Returns:

the query result info

getInvocationContext

public @Nullable io.micronaut.aop.InvocationContext<?,?> getInvocationContext()

Description copied from interface: SqlPreparedQuery

Returns the invocation context associated with this prepared query.

Specified by:

getInvocationContext in interface SqlPreparedQuery<E,R>

Returns:

the invocation context

sizeOf

protected int sizeOf(@Nullable Object value)

Compute the size of the given object.

Parameters:

value - The value

Returns:

The size