Class SqlQueryBuilder
java.lang.Object
io.micronaut.data.model.query.builder.AbstractSqlLikeQueryBuilder
io.micronaut.data.model.query.builder.sql.SqlQueryBuilder
- All Implemented Interfaces:
QueryBuilder
,Annotation
- Direct Known Subclasses:
CosmosSqlQueryBuilder
public class SqlQueryBuilder
extends AbstractSqlLikeQueryBuilder
implements QueryBuilder, SqlQueryConfiguration.DialectConfiguration
Implementation of
QueryBuilder
that builds SQL queries.- Since:
- 1.0.0
- Author:
- graemerocher
-
Nested Class Summary
Nested classes/interfaces inherited from class io.micronaut.data.model.query.builder.AbstractSqlLikeQueryBuilder
AbstractSqlLikeQueryBuilder.CriteriaContext, AbstractSqlLikeQueryBuilder.CriterionHandler<T extends QueryModel.Criterion>, AbstractSqlLikeQueryBuilder.Placeholder, AbstractSqlLikeQueryBuilder.QueryPosition, AbstractSqlLikeQueryBuilder.QueryPropertyPath, AbstractSqlLikeQueryBuilder.QueryState
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
The start of an IN expression.static final String
static final String
Fields inherited from class io.micronaut.data.model.query.builder.AbstractSqlLikeQueryBuilder
ALIAS_REPLACE_QUOTED, AND, AS_CLAUSE, AVG, CANNOT_QUERY_ON_ID_WITH_ENTITY_THAT_HAS_NO_ID, CLOSE_BRACKET, COMMA, COUNT_DISTINCT, DELETE_CLAUSE, DISTINCT, DOT, EQUALS, EQUALS_FALSE, EQUALS_TRUE, FROM_CLAUSE, FUNCTION_COUNT, GREATER_THAN, GREATER_THAN_OR_EQUALS, IS_EMPTY, IS_NOT_EMPTY, IS_NOT_NULL, IS_NULL, JSON_COLUMN, LESS_THAN, LESS_THAN_OR_EQUALS, LOGICAL_AND, LOGICAL_OR, MAX, MIN, NOT, NOT_EQUALS, OPEN_BRACKET, OR, ORDER_BY_CLAUSE, queryHandlers, RETURNING, SELECT_CLAUSE, SPACE, SUM, UPDATE_CLAUSE, WHERE_CLAUSE
Fields inherited from interface io.micronaut.data.model.query.builder.QueryBuilder
VARIABLE_PATTERN
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor.SqlQueryBuilder
(io.micronaut.core.annotation.AnnotationMetadata annotationMetadata) Constructor with annotation metadata.SqlQueryBuilder
(Dialect dialect) -
Method Summary
Modifier and TypeMethodDescriptionClass<? extends Annotation>
protected void
appendForUpdate
(AbstractSqlLikeQueryBuilder.QueryPosition queryPosition, QueryModel query, StringBuilder queryBuilder) Adds "forUpdate" pisimmistic locking.protected void
appendProjectionRowCount
(StringBuilder queryString, String logicalName) Appends a row count projection to the query string.protected void
appendProjectionRowCountDistinct
(StringBuilder queryString, AbstractSqlLikeQueryBuilder.QueryState queryState, PersistentEntity entity, io.micronaut.core.annotation.AnnotationMetadata annotationMetadata, String logicalName) Appends a row count distinct projection to the query string.protected void
appendUpdateSetParameter
(StringBuilder sb, String alias, PersistentProperty prop, Runnable appendParameter) Appends the SET=? call to the query string.protected String
Convert the literal value to it's SQL representation.@NonNull String
buildBatchCreateTableStatement
(@NonNull PersistentEntity... entities) Builds a batch create tables statement.@NonNull String
buildBatchDropTableStatement
(@NonNull PersistentEntity... entities) Builds a batch drop tables statement.@NonNull String[]
buildCreateTableStatements
(@NonNull PersistentEntity entity) Builds the creation table statement.@NonNull String[]
buildDropTableStatements
(@NonNull PersistentEntity entity) Builds the drop table statement.@NonNull QueryResult
buildInsert
(io.micronaut.core.annotation.AnnotationMetadata repositoryMetadata, PersistentEntity entity) Builds an insert statement for the given entity.buildInsertReturning
(io.micronaut.core.annotation.AnnotationMetadata repositoryMetadata, PersistentEntity entity) Builds an insert statement for the given entity.protected String[]
buildJoin
(String alias, JoinPath joinPath, String joinType, StringBuilder target, Map<String, String> appliedJoinPaths, AbstractSqlLikeQueryBuilder.QueryState queryState) Build a join expression for the given alias, association, join type and builder.protected void
buildJoin
(String joinType, StringBuilder sb, AbstractSqlLikeQueryBuilder.QueryState queryState, List<Association> joinAssociationsPath, String joinAlias, Association association, PersistentEntity associatedEntity, PersistentEntity associationOwner, String currentJoinAlias) Builds join, adding fields and criteria.@NonNull String
buildJoinTableInsert
(@NonNull PersistentEntity entity, @NonNull Association association) Builds a join table insert statement for a given entity and association.@NonNull QueryResult
buildPagination
(@NonNull Pageable pageable) Encode the pageable.protected boolean
Whether property path expressions require computation by the implementation.protected void
concat
(StringBuilder writer, Collection<Runnable> partsWriters) dialect()
boolean
formatParameter
(int index) Format the parameter at the given index.protected String
getAliasName
(PersistentEntity entity) Get an alias name for the given entity.getColumnName
(PersistentProperty persistentProperty) Get the column name for the given property.Get dialect.protected String
Get the AS keyword to use for table aliases.getTableName
(PersistentEntity entity) Get the table name for the given entity.protected boolean
isAliasForBatch
(PersistentEntity persistentEntity, io.micronaut.core.annotation.AnnotationMetadata annotationMetadata) Should aliases be used in batch statements.protected boolean
Should embedded queries by expanded by the implementation.static boolean
isForeignKeyWithJoinTable
(@NonNull Association association) Is the given association a foreign key reference that requires a join table.protected String
Quote a column name for the dialect.Resolves the join type.void
selectAllColumns
(io.micronaut.core.annotation.AnnotationMetadata annotationMetadata, PersistentEntity entity, String alias, StringBuilder sb) Selects all columns for the given entity and alias.protected void
selectAllColumns
(io.micronaut.core.annotation.AnnotationMetadata annotationMetadata, AbstractSqlLikeQueryBuilder.QueryState queryState, StringBuilder queryBuffer) Obtain the string that selects all columns from the entity.protected void
selectAllColumnsFromJoinPaths
(AbstractSqlLikeQueryBuilder.QueryState queryState, StringBuilder queryBuffer, Collection<JoinPath> allPaths, @Nullable Map<JoinPath, String> joinAliasOverride) protected GeneratedValue.Type
selectAutoStrategy
(PersistentProperty property) Selects the default fallback strategy.boolean
Whether projections should be aliased.protected boolean
shouldEscape
(@NonNull PersistentEntity entity) Whether queries should be escaped for the given entity.boolean
Whether FOR UPDATE queries are supported.Methods inherited from class io.micronaut.data.model.query.builder.AbstractSqlLikeQueryBuilder
addCriterionHandler, appendAssociationProjection, appendCompoundAssociationProjection, appendCompoundPropertyProjection, appendDeleteClause, appendOrder, appendProperty, appendPropertyProjection, appendPropertyRef, appendTransformed, asLiterals, asPath, asQueryPropertyPath, buildAdditionalWhereClause, buildAdditionalWhereString, buildAdditionalWhereString, buildDelete, buildOrderBy, buildOrderBy, buildOrderBy, buildQuery, buildSelect, buildUpdate, buildUpdate, buildWhereClause, checkDialectSupportsJsonEntity, getAliasName, getColumnAlias, getDataTransformerReadValue, getDataTransformerWriteValue, getMappedName, getMappedName, getMappedName, getNamingStrategy, getNamingStrategy, getPathOnlyAliasName, getUnescapedTableName, handleSubQuery, isJsonEntity, newBindingContext, resolveWhereForAnnotationMetadata, selectAllColumns, traversePersistentProperties, traversePersistentProperties, traversePersistentProperties, traversePersistentProperties
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.model.query.builder.QueryBuilder
buildDelete, buildDelete, buildOrderBy, buildQuery, buildUpdate, buildUpdate, buildUpdate, buildUpdate
-
Field Details
-
DEFAULT_POSITIONAL_PARAMETER_MARKER
The start of an IN expression.- See Also:
-
STANDARD_FOR_UPDATE_CLAUSE
- See Also:
-
SQL_SERVER_FOR_UPDATE_CLAUSE
- See Also:
-
-
Constructor Details
-
SqlQueryBuilder
@Creator public SqlQueryBuilder(io.micronaut.core.annotation.AnnotationMetadata annotationMetadata) Constructor with annotation metadata.- Parameters:
annotationMetadata
- The annotation metadata
-
SqlQueryBuilder
public SqlQueryBuilder()Default constructor. -
SqlQueryBuilder
- Parameters:
dialect
- The dialect
-
-
Method Details
-
getDialect
Description copied from class:AbstractSqlLikeQueryBuilder
Get dialect.- Overrides:
getDialect
in classAbstractSqlLikeQueryBuilder
- Returns:
- The dialect being used by the builder.
-
shouldEscape
Description copied from class:AbstractSqlLikeQueryBuilder
Whether queries should be escaped for the given entity.- Overrides:
shouldEscape
in classAbstractSqlLikeQueryBuilder
- Parameters:
entity
- The entity- Returns:
- True if they should be escaped
-
asLiteral
Description copied from class:AbstractSqlLikeQueryBuilder
Convert the literal value to it's SQL representation.- Overrides:
asLiteral
in classAbstractSqlLikeQueryBuilder
- Parameters:
value
- The literal value- Returns:
- converter value
-
shouldAliasProjections
public boolean shouldAliasProjections()Description copied from interface:QueryBuilder
Whether projections should be aliased.- Specified by:
shouldAliasProjections
in interfaceQueryBuilder
- Returns:
- True if they should
-
isExpandEmbedded
protected boolean isExpandEmbedded()Description copied from class:AbstractSqlLikeQueryBuilder
Should embedded queries by expanded by the implementation.- Overrides:
isExpandEmbedded
in classAbstractSqlLikeQueryBuilder
- Returns:
- True if they should
-
buildBatchCreateTableStatement
@NonNull public @NonNull String buildBatchCreateTableStatement(@NonNull @NonNull PersistentEntity... entities) Builds a batch create tables statement. Designed for testing and not production usage. For production a SQL migration tool such as Flyway or Liquibase is recommended.- Parameters:
entities
- the entities- Returns:
- The table
-
buildBatchDropTableStatement
@NonNull public @NonNull String buildBatchDropTableStatement(@NonNull @NonNull PersistentEntity... entities) Builds a batch drop tables statement. Designed for testing and not production usage. For production a SQL migration tool such as Flyway or Liquibase is recommended.- Parameters:
entities
- the entities- Returns:
- The table
-
buildDropTableStatements
@NonNull public @NonNull String[] buildDropTableStatements(@NonNull @NonNull PersistentEntity entity) Builds the drop table statement. Designed for testing and not production usage. For production a SQL migration tool such as Flyway or Liquibase is recommended.- Parameters:
entity
- The entity- Returns:
- The tables for the give entity
-
buildJoinTableInsert
@NonNull public @NonNull String buildJoinTableInsert(@NonNull @NonNull PersistentEntity entity, @NonNull @NonNull Association association) Builds a join table insert statement for a given entity and association.- Parameters:
entity
- The entityassociation
- The association- Returns:
- The join table insert statement
-
isForeignKeyWithJoinTable
Is the given association a foreign key reference that requires a join table.- Parameters:
association
- The association.- Returns:
- True if it is.
-
buildCreateTableStatements
@NonNull public @NonNull String[] buildCreateTableStatements(@NonNull @NonNull PersistentEntity entity) Builds the creation table statement. Designed for testing and not production usage. For production a SQL migration tool such as Flyway or Liquibase is recommended.- Parameters:
entity
- The entity- Returns:
- The tables for the give entity
-
getTableAsKeyword
Description copied from class:AbstractSqlLikeQueryBuilder
Get the AS keyword to use for table aliases.- Overrides:
getTableAsKeyword
in classAbstractSqlLikeQueryBuilder
- Returns:
- The AS keyword if any
-
selectAllColumns
protected void selectAllColumns(io.micronaut.core.annotation.AnnotationMetadata annotationMetadata, AbstractSqlLikeQueryBuilder.QueryState queryState, StringBuilder queryBuffer) Description copied from class:AbstractSqlLikeQueryBuilder
Obtain the string that selects all columns from the entity.- Specified by:
selectAllColumns
in classAbstractSqlLikeQueryBuilder
- Parameters:
annotationMetadata
- The annotation metadataqueryState
- The query state
-
selectAllColumnsFromJoinPaths
@Internal protected void selectAllColumnsFromJoinPaths(AbstractSqlLikeQueryBuilder.QueryState queryState, StringBuilder queryBuffer, Collection<JoinPath> allPaths, @Nullable @Nullable Map<JoinPath, String> joinAliasOverride) - Overrides:
selectAllColumnsFromJoinPaths
in classAbstractSqlLikeQueryBuilder
-
selectAllColumns
public void selectAllColumns(io.micronaut.core.annotation.AnnotationMetadata annotationMetadata, PersistentEntity entity, String alias, StringBuilder sb) Selects all columns for the given entity and alias.- Specified by:
selectAllColumns
in classAbstractSqlLikeQueryBuilder
- Parameters:
annotationMetadata
- The annotation metadataentity
- The entityalias
- The aliassb
- The builder to add the columns
-
resolveJoinType
Description copied from class:AbstractSqlLikeQueryBuilder
Resolves the join type.- Specified by:
resolveJoinType
in classAbstractSqlLikeQueryBuilder
- Parameters:
jt
- The join type- Returns:
- The join type.
-
buildInsert
@NonNull public @NonNull QueryResult buildInsert(io.micronaut.core.annotation.AnnotationMetadata repositoryMetadata, PersistentEntity entity) Description copied from interface:QueryBuilder
Builds an insert statement for the given entity.- Specified by:
buildInsert
in interfaceQueryBuilder
- Parameters:
repositoryMetadata
- The repository annotation metadataentity
- The entity- Returns:
- The insert statement or null if the implementation doesn't require insert statements
-
buildInsertReturning
public QueryResult buildInsertReturning(io.micronaut.core.annotation.AnnotationMetadata repositoryMetadata, PersistentEntity entity) Description copied from interface:QueryBuilder
Builds an insert statement for the given entity.- Specified by:
buildInsertReturning
in interfaceQueryBuilder
- Parameters:
repositoryMetadata
- The repository annotation metadataentity
- The entity- Returns:
- The insert statement or null if the implementation doesn't require insert statements
-
buildPagination
Description copied from interface:QueryBuilder
Encode the pageable.- Specified by:
buildPagination
in interfaceQueryBuilder
- Parameters:
pageable
- The pageable- Returns:
- The encoded query
-
getAliasName
Description copied from class:AbstractSqlLikeQueryBuilder
Get an alias name for the given entity.- Overrides:
getAliasName
in classAbstractSqlLikeQueryBuilder
- Parameters:
entity
- The entity- Returns:
- The alias name
-
getTableName
Description copied from class:AbstractSqlLikeQueryBuilder
Get the table name for the given entity.- Specified by:
getTableName
in classAbstractSqlLikeQueryBuilder
- Parameters:
entity
- The entity- Returns:
- The table name
-
concat
- Overrides:
concat
in classAbstractSqlLikeQueryBuilder
- Parameters:
partsWriters
- The parts writerswriter
- The writer
-
appendUpdateSetParameter
protected void appendUpdateSetParameter(StringBuilder sb, String alias, PersistentProperty prop, Runnable appendParameter) Description copied from class:AbstractSqlLikeQueryBuilder
Appends the SET=? call to the query string.- Overrides:
appendUpdateSetParameter
in classAbstractSqlLikeQueryBuilder
- Parameters:
sb
- The string builderalias
- The aliasprop
- The propertyappendParameter
- The append parameter action
-
buildJoin
protected String[] buildJoin(String alias, JoinPath joinPath, String joinType, StringBuilder target, Map<String, String> appliedJoinPaths, AbstractSqlLikeQueryBuilder.QueryState queryState) Description copied from class:AbstractSqlLikeQueryBuilder
Build a join expression for the given alias, association, join type and builder.- Specified by:
buildJoin
in classAbstractSqlLikeQueryBuilder
- Parameters:
alias
- The aliasjoinPath
- The join pathjoinType
- The join type stringtarget
- The target builderappliedJoinPaths
- The applied joins pathsqueryState
- The query state- Returns:
- An array representing the aliases for each join association in the specified join path
-
buildJoin
protected void buildJoin(String joinType, StringBuilder sb, AbstractSqlLikeQueryBuilder.QueryState queryState, List<Association> joinAssociationsPath, String joinAlias, Association association, PersistentEntity associatedEntity, PersistentEntity associationOwner, String currentJoinAlias) Builds join, adding fields and criteria.- Parameters:
joinType
- the join typesb
- string builder that join will be added toqueryState
- the query statejoinAssociationsPath
- the list of associationsjoinAlias
- the join aliasassociation
- the associationassociatedEntity
- the associated entityassociationOwner
- the association ownercurrentJoinAlias
- the current join alias
-
quote
Quote a column name for the dialect.- Overrides:
quote
in classAbstractSqlLikeQueryBuilder
- Parameters:
persistedName
- The persisted name.- Returns:
- The quoted name
-
getColumnName
Description copied from class:AbstractSqlLikeQueryBuilder
Get the column name for the given property.- Specified by:
getColumnName
in classAbstractSqlLikeQueryBuilder
- Parameters:
persistentProperty
- The property- Returns:
- The column name
-
appendProjectionRowCount
Description copied from class:AbstractSqlLikeQueryBuilder
Appends a row count projection to the query string.- Specified by:
appendProjectionRowCount
in classAbstractSqlLikeQueryBuilder
- Parameters:
queryString
- The query stringlogicalName
- The alias to the table name
-
appendProjectionRowCountDistinct
protected void appendProjectionRowCountDistinct(StringBuilder queryString, AbstractSqlLikeQueryBuilder.QueryState queryState, PersistentEntity entity, io.micronaut.core.annotation.AnnotationMetadata annotationMetadata, String logicalName) Description copied from class:AbstractSqlLikeQueryBuilder
Appends a row count distinct projection to the query string.- Specified by:
appendProjectionRowCountDistinct
in classAbstractSqlLikeQueryBuilder
- Parameters:
queryString
- The query stringqueryState
- The query stateentity
- The persistent entityannotationMetadata
- The query annotation metadatalogicalName
- The alias to the table name
-
appendForUpdate
protected void appendForUpdate(AbstractSqlLikeQueryBuilder.QueryPosition queryPosition, QueryModel query, StringBuilder queryBuilder) Description copied from class:AbstractSqlLikeQueryBuilder
Adds "forUpdate" pisimmistic locking.- Overrides:
appendForUpdate
in classAbstractSqlLikeQueryBuilder
- Parameters:
queryPosition
- The query positionquery
- The queryqueryBuilder
- The builder
-
computePropertyPaths
protected boolean computePropertyPaths()Description copied from class:AbstractSqlLikeQueryBuilder
Whether property path expressions require computation by the implementation. In a certain query dialects property paths are supported (such as JPA-QL where you can do select foo.bar) whilst for explicit SQL queries paths like this have to be computed into aliases / column name references.- Specified by:
computePropertyPaths
in classAbstractSqlLikeQueryBuilder
- Returns:
- True if property path computation is required.
-
isAliasForBatch
protected boolean isAliasForBatch(PersistentEntity persistentEntity, io.micronaut.core.annotation.AnnotationMetadata annotationMetadata) Description copied from class:AbstractSqlLikeQueryBuilder
Should aliases be used in batch statements.- Specified by:
isAliasForBatch
in classAbstractSqlLikeQueryBuilder
- Parameters:
persistentEntity
- the persistent entityannotationMetadata
- the method annotation metadata- Returns:
- True if they should
-
formatParameter
Description copied from class:AbstractSqlLikeQueryBuilder
Format the parameter at the given index.- Specified by:
formatParameter
in classAbstractSqlLikeQueryBuilder
- Parameters:
index
- The parameter- Returns:
- The index
-
selectAutoStrategy
Selects the default fallback strategy. For a generated value.- Parameters:
property
- The Persistent property- Returns:
- The generated value
-
supportsForUpdate
public boolean supportsForUpdate()Description copied from interface:QueryBuilder
Whether FOR UPDATE queries are supported.- Specified by:
supportsForUpdate
in interfaceQueryBuilder
- Returns:
- True if FOR UPDATE queries are supported
-
dialect
-
positionalParameterFormat
-
positionalParameterName
-
positionalParameterPattern
- Returns:
- The regex pattern for positional parameters.
-
escapeQueries
public boolean escapeQueries() -
annotationType
- Specified by:
annotationType
in interfaceAnnotation
-