Interface SqlStoredQuery<E,R>

Type Parameters:

E - The entity type

R - The result type

All Superinterfaces:

io.micronaut.core.annotation.AnnotationMetadataProvider, io.micronaut.core.annotation.AnnotationSource, BindableParametersStoredQuery<E,R>, io.micronaut.core.naming.Named, PersistentEntityAwareQuery<E>, StoredDataOperation<R>, StoredQuery<E,R>

All Known Subinterfaces:

SqlPreparedQuery<E,R>

All Known Implementing Classes:

DefaultSqlPreparedQuery, DefaultSqlStoredQuery

@Internal
public interface SqlStoredQuery<E,R>
extends BindableParametersStoredQuery<E,R>

SQL version of BindableParametersStoredQuery carrying extra SQL related data.

Since:

3.5.0

Author:

Denis Stepanov

Nested Class Summary

Nested classes/interfaces inherited from interface BindableParametersStoredQuery

BindableParametersStoredQuery.Binder

Nested classes/interfaces inherited from interface StoredQuery

StoredQuery.OperationType

Field Summary

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

EMPTY

Method Summary

Modifier and Type	Method	Description
@Nullable Map<QueryParameterBinding, Object>	collectAutoPopulatedPreviousValues(E entity)	Collect auto-populated property values before pre-actions are triggered and property values are modified.
Dialect	getDialect()	Get dialect.
default @Nullable String	getDialectVersion()
SqlQueryBuilder	getQueryBuilder()
@Nullable QueryResultInfo	getQueryResultInfo()
default boolean	isDialectVersionAtLeast(String requiredVersion)
boolean	isExpandableQuery()

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

findAnnotation, findAnnotation, findDeclaredAnnotation, findDeclaredAnnotation, getAnnotationMetadata, 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 BindableParametersStoredQuery

bindParameters

Methods inherited from interface io.micronaut.core.naming.Named

getName

Methods inherited from interface PersistentEntityAwareQuery

getPersistentEntity

Methods inherited from interface StoredQuery

getExpandableQueryParts, getJoinPaths, getOperationType, getOutParameterBindings, getParameterExpressions, getQuery, getQueryBindings, getQueryHints, getQueryLimit, getResultArgument, getResultDataType, getResultType, getRootEntity, getSort, hasPageable, hasResultConsumer, isCount, isDtoProjection, isJsonEntity, isNative, isOptimisticLock, isProcedure, isRawQuery

Method Details

isExpandableQuery

boolean isExpandableQuery()

Returns:

true if query is expandable

getDialect

Dialect getDialect()

Get dialect.

Returns:

dialect

isDialectVersionAtLeast

default boolean isDialectVersionAtLeast(String requiredVersion)

Parameters:

requiredVersion - The required target dialect version

Returns:

Whether the configured target dialect version meets the requirement

getDialectVersion

default @Nullable String getDialectVersion()

Returns:

The normalized target dialect version, or null when none is configured

getQueryBuilder

SqlQueryBuilder getQueryBuilder()

Returns:

query builder for possible modification in the prepared query

collectAutoPopulatedPreviousValues

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

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

Parameters:

entity - The entity instance

Returns:

collected values

getQueryResultInfo

@Nullable QueryResultInfo getQueryResultInfo()

Returns:

the query result info

Since:

4.2.0