Package io.micronaut.data.model.query.builder.sql

Class SqlQueryBuilder2

java.lang.Object

io.micronaut.data.model.query.builder.sql.AbstractSqlLikeQueryBuilder2

io.micronaut.data.model.query.builder.sql.SqlQueryBuilder2

All Implemented Interfaces:

Annotation

Direct Known Subclasses:

CosmosSqlQueryBuilder2

@Internal
public class SqlQueryBuilder2
extends AbstractSqlLikeQueryBuilder2
implements SqlQueryConfiguration.DialectConfiguration

Implementation of QueryBuilder that builds SQL queries.

Since:

1.0.0

Author:

graemerocher, Denis Stepanov

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	SqlQueryBuilder2.InsertQueryDefinitionImpl	The insert query definition.
protected class	SqlQueryBuilder2.SqlSelectionVisitor

Nested classes/interfaces inherited from class io.micronaut.data.model.query.builder.sql.AbstractSqlLikeQueryBuilder2

AbstractSqlLikeQueryBuilder2.Placeholder, AbstractSqlLikeQueryBuilder2.QueryPosition, AbstractSqlLikeQueryBuilder2.QueryPropertyPath, AbstractSqlLikeQueryBuilder2.QueryState, AbstractSqlLikeQueryBuilder2.SqlPredicateVisitor

Nested classes/interfaces inherited from interface io.micronaut.data.model.query.builder.QueryBuilder2

QueryBuilder2.BaseQueryDefinition, QueryBuilder2.DeleteQueryDefinition, QueryBuilder2.InsertQueryDefinition, QueryBuilder2.SelectQueryDefinition, QueryBuilder2.UpdateQueryDefinition

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_POSITIONAL_PARAMETER_MARKER	The start of an IN expression.
static final String	SQL_SERVER_FOR_UPDATE_CLAUSE
static final String	STANDARD_FOR_UPDATE_CLAUSE

Fields inherited from class io.micronaut.data.model.query.builder.sql.AbstractSqlLikeQueryBuilder2

ALIAS_REPLACE_QUOTED, AND, AS_CLAUSE, CANNOT_QUERY_ON_ID_WITH_ENTITY_THAT_HAS_NO_ID, CLOSE_BRACKET, COMMA, DISTINCT, DOT, FROM_CLAUSE, LOGICAL_AND, LOGICAL_OR, NOT, OPEN_BRACKET, OR, ORDER_BY_CLAUSE, RETURNING, SELECT_CLAUSE, SPACE, WHERE_CLAUSE

Constructor Summary

Constructors

Constructor	Description
SqlQueryBuilder2()	Default constructor.
SqlQueryBuilder2(io.micronaut.core.annotation.AnnotationMetadata annotationMetadata)	Constructor with annotation metadata.
SqlQueryBuilder2(Dialect dialect)

Method Summary

Modifier and Type	Method	Description
Class<? extends Annotation>	annotationType()
protected void	appendForUpdate(AbstractSqlLikeQueryBuilder2.QueryPosition queryPosition, QueryBuilder2.SelectQueryDefinition definition, StringBuilder queryBuilder)	Adds "forUpdate" pessimistic locking.
protected void	appendUpdateSetParameter(StringBuilder sb, String alias, PersistentProperty prop, Runnable appendParameter)	Appends the SET=? call to the query string.
protected String	asLiteral(Object value)	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, QueryBuilder2.InsertQueryDefinition definition)
protected void	buildJoin(String joinType, StringBuilder query, AbstractSqlLikeQueryBuilder2.QueryState queryState, PersistentAssociationPath joinAssociation, PersistentEntity associationOwner, String currentJoinAlias, String lastJoinAlias)	Build a join expression for the given alias, association, join type and builder.
@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)
protected boolean	computePropertyPaths()	Whether property path expressions require computation by the implementation.
protected SqlQueryBuilder2.SqlSelectionVisitor	createSelectionVisitor(io.micronaut.core.annotation.AnnotationMetadata annotationMetadata, AbstractSqlLikeQueryBuilder2.QueryState queryState, boolean distinct)	Create a selection visitor.
Dialect	dialect()
boolean	escapeQueries()
AbstractSqlLikeQueryBuilder2.Placeholder	formatParameter(int index)	Format the parameter at the given index.
protected String	getAliasName(PersistentEntity entity)	Get an alias name for the given entity.
String	getColumnName(PersistentProperty persistentProperty)	Get the column name for the given property.
Dialect	getDialect()	Get dialect.
protected String	getTableAsKeyword()	Get the AS keyword to use for table aliases.
String	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.
static boolean	isForeignKeyWithJoinTable(@NonNull Association association)	Is the given association a foreign key reference that requires a join table.
String	positionalParameterFormat()
String	positionalParameterName()
protected String	quote(String persistedName)	Quote a column name for the dialect.
String	resolveJoinType(Join.Type jt)	Resolves the join type.
protected GeneratedValue.Type	selectAutoStrategy(PersistentProperty property)	Selects the default fallback strategy.
protected boolean	shouldEscape(@NonNull PersistentEntity entity)	Whether queries should be escaped for the given entity.

Methods inherited from class io.micronaut.data.model.query.builder.sql.AbstractSqlLikeQueryBuilder2

appendDeleteClause, appendExpression, appendOrder, appendPropertyRef, appendTransformed, asPath, asQueryPropertyPath, buildAdditionalWhereClause, buildAdditionalWhereString, buildAdditionalWhereString, buildDelete, buildOrderBy, buildPropertyByName, buildSelect, buildSelect, buildUpdate, buildWhereClause, checkDialectSupportsJsonEntity, createPredicateVisitor, getAliasName, getColumnAlias, getDataTransformerReadValue, getDataTransformerWriteValue, getMappedName, getMappedName, getMappedName, getNamingStrategy, getNamingStrategy, getPathOnlyAliasName, getUnescapedTableName, isJsonEntity, newBindingContext, resolveWhereForAnnotationMetadata, traverseEmbedded

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_POSITIONAL_PARAMETER_MARKER

public static final String DEFAULT_POSITIONAL_PARAMETER_MARKER

The start of an IN expression.

See Also:

• Constant Field Values

STANDARD_FOR_UPDATE_CLAUSE

public static final String STANDARD_FOR_UPDATE_CLAUSE

See Also:

• Constant Field Values

SQL_SERVER_FOR_UPDATE_CLAUSE

public static final String SQL_SERVER_FOR_UPDATE_CLAUSE

See Also:

• Constant Field Values

Constructor Details

SqlQueryBuilder2

@Creator
public SqlQueryBuilder2(io.micronaut.core.annotation.AnnotationMetadata annotationMetadata)

Constructor with annotation metadata.

Parameters:

annotationMetadata - The annotation metadata

SqlQueryBuilder2

public SqlQueryBuilder2()

Default constructor.

SqlQueryBuilder2

public SqlQueryBuilder2(Dialect dialect)

Parameters:

dialect - The dialect

Method Details

getDialect

public Dialect getDialect()

Description copied from class: AbstractSqlLikeQueryBuilder2

Get dialect.

Overrides:

getDialect in class AbstractSqlLikeQueryBuilder2

Returns:

The dialect being used by the builder.

shouldEscape

protected boolean shouldEscape(@NonNull
 @NonNull PersistentEntity entity)

Description copied from class: AbstractSqlLikeQueryBuilder2

Whether queries should be escaped for the given entity.

Overrides:

shouldEscape in class AbstractSqlLikeQueryBuilder2

Parameters:

entity - The entity

Returns:

True if they should be escaped

asLiteral

protected String asLiteral(Object value)

Description copied from class: AbstractSqlLikeQueryBuilder2

Convert the literal value to it's SQL representation.

Overrides:

asLiteral in class AbstractSqlLikeQueryBuilder2

Parameters:

value - The literal value

Returns:

converter value

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 entity

association - The association

Returns:

The join table insert statement

isForeignKeyWithJoinTable

public static boolean isForeignKeyWithJoinTable(@NonNull
 @NonNull Association association)

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

protected String getTableAsKeyword()

Description copied from class: AbstractSqlLikeQueryBuilder2

Get the AS keyword to use for table aliases.

Overrides:

getTableAsKeyword in class AbstractSqlLikeQueryBuilder2

Returns:

The AS keyword if any

createSelectionVisitor

protected SqlQueryBuilder2.SqlSelectionVisitor createSelectionVisitor(io.micronaut.core.annotation.AnnotationMetadata annotationMetadata,
 AbstractSqlLikeQueryBuilder2.QueryState queryState,
 boolean distinct)

Description copied from class: AbstractSqlLikeQueryBuilder2

Create a selection visitor.

Overrides:

createSelectionVisitor in class AbstractSqlLikeQueryBuilder2

Parameters:

annotationMetadata - The annotation metadata

queryState - The query state

distinct - The distinct

Returns:

The visitor

resolveJoinType

public String resolveJoinType(Join.Type jt)

Description copied from class: AbstractSqlLikeQueryBuilder2

Resolves the join type.

Specified by:

resolveJoinType in class AbstractSqlLikeQueryBuilder2

Parameters:

jt - The join type

Returns:

The join type.

buildInsert

@NonNull
public @NonNull QueryResult buildInsert(io.micronaut.core.annotation.AnnotationMetadata repositoryMetadata,
 QueryBuilder2.InsertQueryDefinition definition)

buildPagination

@NonNull
public @NonNull QueryResult buildPagination(@NonNull
 @NonNull Pageable pageable)

getAliasName

protected String getAliasName(PersistentEntity entity)

Description copied from class: AbstractSqlLikeQueryBuilder2

Get an alias name for the given entity.

Overrides:

getAliasName in class AbstractSqlLikeQueryBuilder2

Parameters:

entity - The entity

Returns:

The alias name

getTableName

public String getTableName(PersistentEntity entity)

Description copied from class: AbstractSqlLikeQueryBuilder2

Get the table name for the given entity.

Specified by:

getTableName in class AbstractSqlLikeQueryBuilder2

Parameters:

entity - The entity

Returns:

The table name

appendUpdateSetParameter

protected void appendUpdateSetParameter(StringBuilder sb,
 String alias,
 PersistentProperty prop,
 Runnable appendParameter)

Description copied from class: AbstractSqlLikeQueryBuilder2

Appends the SET=? call to the query string.

Overrides:

appendUpdateSetParameter in class AbstractSqlLikeQueryBuilder2

Parameters:

sb - The string builder

alias - The alias

prop - The property

appendParameter - The append parameter action

buildJoin

protected void buildJoin(String joinType,
 StringBuilder query,
 AbstractSqlLikeQueryBuilder2.QueryState queryState,
 PersistentAssociationPath joinAssociation,
 PersistentEntity associationOwner,
 String currentJoinAlias,
 String lastJoinAlias)

Description copied from class: AbstractSqlLikeQueryBuilder2

Build a join expression for the given alias, association, join type and builder.

Overrides:

buildJoin in class AbstractSqlLikeQueryBuilder2

Parameters:

joinType - The join type

query - The query builder

queryState - The state

joinAssociation - The association

associationOwner - The associated owner

currentJoinAlias - The current join alias

lastJoinAlias - The last join alias

quote

protected String quote(String persistedName)

Quote a column name for the dialect.

Overrides:

quote in class AbstractSqlLikeQueryBuilder2

Parameters:

persistedName - The persisted name.

Returns:

The quoted name

getColumnName

public String getColumnName(PersistentProperty persistentProperty)

Description copied from class: AbstractSqlLikeQueryBuilder2

Get the column name for the given property.

Specified by:

getColumnName in class AbstractSqlLikeQueryBuilder2

Parameters:

persistentProperty - The property

Returns:

The column name

appendForUpdate

protected void appendForUpdate(AbstractSqlLikeQueryBuilder2.QueryPosition queryPosition,
 QueryBuilder2.SelectQueryDefinition definition,
 StringBuilder queryBuilder)

Description copied from class: AbstractSqlLikeQueryBuilder2

Adds "forUpdate" pessimistic locking.

Overrides:

appendForUpdate in class AbstractSqlLikeQueryBuilder2

Parameters:

queryPosition - The query position

definition - The definition

queryBuilder - The builder

computePropertyPaths

protected boolean computePropertyPaths()

Description copied from class: AbstractSqlLikeQueryBuilder2

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 class AbstractSqlLikeQueryBuilder2

Returns:

True if property path computation is required.

isAliasForBatch

protected boolean isAliasForBatch(PersistentEntity persistentEntity,
 io.micronaut.core.annotation.AnnotationMetadata annotationMetadata)

Description copied from class: AbstractSqlLikeQueryBuilder2

Should aliases be used in batch statements.

Specified by:

isAliasForBatch in class AbstractSqlLikeQueryBuilder2

Parameters:

persistentEntity - the persistent entity

annotationMetadata - the method annotation metadata

Returns:

True if they should

formatParameter

public AbstractSqlLikeQueryBuilder2.Placeholder formatParameter(int index)

Description copied from class: AbstractSqlLikeQueryBuilder2

Format the parameter at the given index.

Specified by:

formatParameter in class AbstractSqlLikeQueryBuilder2

Parameters:

index - The parameter

Returns:

The index

selectAutoStrategy

protected GeneratedValue.Type selectAutoStrategy(PersistentProperty property)

Selects the default fallback strategy. For a generated value.

Parameters:

property - The Persistent property

Returns:

The generated value

dialect

public Dialect dialect()

positionalParameterFormat

public String positionalParameterFormat()

positionalParameterName

public String positionalParameterName()

escapeQueries

public boolean escapeQueries()

annotationType

public Class<? extends Annotation> annotationType()

Specified by:

annotationType in interface Annotation