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

Class CosmosSqlQueryBuilder

java.lang.Object

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

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

io.micronaut.data.document.model.query.builder.CosmosSqlQueryBuilder

All Implemented Interfaces:

QueryBuilder

@Internal
public final class CosmosSqlQueryBuilder
extends SqlQueryBuilder

The Azure Cosmos DB sql query builder.

Since:

3.9.0

Author:

radovanradic

Nested Class Summary

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

SqlQueryBuilder.SqlSelectionVisitor

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

AbstractSqlLikeQueryBuilder.ExpressionAppender, AbstractSqlLikeQueryBuilder.Placeholder, AbstractSqlLikeQueryBuilder.QueryBuilder, AbstractSqlLikeQueryBuilder.QueryPosition, AbstractSqlLikeQueryBuilder.QueryPropertyPath, AbstractSqlLikeQueryBuilder.QueryState, AbstractSqlLikeQueryBuilder.SqlPredicateVisitor

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

QueryBuilder.BaseQueryDefinition, QueryBuilder.DeleteQueryDefinition, QueryBuilder.InsertQueryDefinition, QueryBuilder.SelectQueryDefinition, QueryBuilder.UpdateQueryDefinition

Field Summary

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

DEFAULT_POSITIONAL_PARAMETER_MARKER, SQL_SERVER_FOR_UPDATE_CLAUSE, STANDARD_FOR_UPDATE_CLAUSE

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

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
CosmosSqlQueryBuilder(io.micronaut.core.annotation.AnnotationMetadata annotationMetadata)

Method Summary

Modifier and Type	Method	Description
protected StringBuilder	appendDeleteClause(StringBuilder queryString)	Append the delete clause.
protected String	asLiteral(Object value)	Convert the literal value to it's SQL representation.
QueryResult	buildInsert(io.micronaut.core.annotation.AnnotationMetadata repositoryMetadata, QueryBuilder.InsertQueryDefinition definition)	Builds an insert statement for the given entity.
protected void	buildJoin(String joinType, StringBuilder query, AbstractSqlLikeQueryBuilder.QueryState queryState, PersistentAssociationPath joinAssociation, PersistentEntity associationOwner, String currentJoinAlias, String lastJoinAlias)	Build a join expression for the given alias, association, join type and builder.
String	buildLimitAndOffset(long limit, long offset)	Generate the limit and offset query.
QueryResult	buildSelect(@NonNull io.micronaut.core.annotation.AnnotationMetadata annotationMetadata, @NonNull QueryBuilder.SelectQueryDefinition definition)	Encode the given query for the passed annotation metadata and query.
QueryResult	buildUpdate(io.micronaut.core.annotation.AnnotationMetadata annotationMetadata, QueryBuilder.UpdateQueryDefinition definition)	Encode the given query into the encoded query instance.
protected boolean	computePropertyPaths()	Whether property path expressions require computation by the implementation.
protected AbstractSqlLikeQueryBuilder.SqlPredicateVisitor	createPredicateVisitor(io.micronaut.core.annotation.AnnotationMetadata annotationMetadata, AbstractSqlLikeQueryBuilder.QueryState queryState)	Create a predicate visitor.
protected SqlQueryBuilder.SqlSelectionVisitor	createSelectionVisitor(io.micronaut.core.annotation.AnnotationMetadata annotationMetadata, AbstractSqlLikeQueryBuilder.QueryState queryState, boolean distinct)	Create a selection visitor.
protected NamingStrategy	getNamingStrategy(PersistentEntity entity)	Gets NamingStrategy for the entity.
protected NamingStrategy	getNamingStrategy(PersistentPropertyPath propertyPath)	Gets NamingStrategy for the property path.
protected boolean	isAliasForBatch(PersistentEntity persistentEntity, io.micronaut.core.annotation.AnnotationMetadata annotationMetadata)	Should aliases be used in batch statements.
protected boolean	traverseEmbedded()

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

appendForUpdate, appendLimitAndOrder, appendUpdateSetParameter, buildBatchCreateTableStatement, buildBatchDropTableStatement, buildCreateTableStatements, buildCreateTableStatements, buildDropTableStatements, buildJoinTableInsert, formatParameter, getAliasName, getColumnName, getDialect, getTableAsKeyword, getTableName, isForeignKeyWithJoinTable, positionalParameterFormat, quote, resolveJoinType, selectAutoStrategy, shouldEscape

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

appendExpression, appendLimitAndOffset, appendOrder, appendPropertyRef, appendTransformed, asPath, asQueryPropertyPath, buildAdditionalWhereClause, buildAdditionalWhereString, buildAdditionalWhereString, buildDelete, buildOrderBy, buildPropertyByName, buildQuery, buildSelect, buildWhereClause, checkDialectSupportsJsonEntity, getAliasName, getColumnAlias, getDataTransformerReadValue, getDataTransformerWriteValue, getMappedName, getMappedName, getMappedName, getPathOnlyAliasName, getUnescapedTableName, isJsonEntity, newBindingContext, parameterInRoleModifiesLimit, parameterInRoleModifiesOrder, quote, resolveWhereForAnnotationMetadata, shouldAppendOrder, supportsLimitQuery

Methods inherited from class java.lang.Object

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

Constructor Details

CosmosSqlQueryBuilder

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

Method Details

asLiteral

protected String asLiteral(Object value)

Description copied from class: AbstractSqlLikeQueryBuilder

Convert the literal value to it's SQL representation.

Overrides:

asLiteral in class SqlQueryBuilder

Parameters:

value - The literal value

Returns:

converter value

traverseEmbedded

protected boolean traverseEmbedded()

Overrides:

traverseEmbedded in class AbstractSqlLikeQueryBuilder

Returns:

True if embedded properties should be traversed

createSelectionVisitor

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

Description copied from class: AbstractSqlLikeQueryBuilder

Create a selection visitor.

Overrides:

createSelectionVisitor in class SqlQueryBuilder

Parameters:

annotationMetadata - The annotation metadata

queryState - The query state

distinct - The distinct

Returns:

The visitor

createPredicateVisitor

protected AbstractSqlLikeQueryBuilder.SqlPredicateVisitor createPredicateVisitor(io.micronaut.core.annotation.AnnotationMetadata annotationMetadata,
 AbstractSqlLikeQueryBuilder.QueryState queryState)

Description copied from class: AbstractSqlLikeQueryBuilder

Create a predicate visitor.

Overrides:

createPredicateVisitor in class AbstractSqlLikeQueryBuilder

Parameters:

annotationMetadata - The annotation metadata

queryState - The query state

Returns:

The visitor

getNamingStrategy

protected NamingStrategy getNamingStrategy(PersistentEntity entity)

Description copied from class: AbstractSqlLikeQueryBuilder

Gets NamingStrategy for the entity. Subclasses might override and potentially provide different strategy in some cases.

Overrides:

getNamingStrategy in class AbstractSqlLikeQueryBuilder

Parameters:

entity - the persistent entity

Returns:

naming strategy for the entity

getNamingStrategy

protected NamingStrategy getNamingStrategy(PersistentPropertyPath propertyPath)

Description copied from class: AbstractSqlLikeQueryBuilder

Gets NamingStrategy for the property path. Subclasses might override and potentially provide different strategy in some cases.

Overrides:

getNamingStrategy in class AbstractSqlLikeQueryBuilder

Parameters:

propertyPath - the property path representation

Returns:

naming strategy for the property path

buildSelect

public QueryResult buildSelect(@NonNull
 @NonNull io.micronaut.core.annotation.AnnotationMetadata annotationMetadata,
 @NonNull
 @NonNull QueryBuilder.SelectQueryDefinition definition)

Description copied from interface: QueryBuilder

Encode the given query for the passed annotation metadata and query.

Specified by:

buildSelect in interface QueryBuilder

Overrides:

buildSelect in class AbstractSqlLikeQueryBuilder

Parameters:

annotationMetadata - The annotation metadata

definition - The query model

Returns:

The query result

buildJoin

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

Description copied from class: AbstractSqlLikeQueryBuilder

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

Overrides:

buildJoin in class SqlQueryBuilder

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

appendDeleteClause

protected StringBuilder appendDeleteClause(StringBuilder queryString)

Description copied from class: AbstractSqlLikeQueryBuilder

Append the delete clause.

Overrides:

appendDeleteClause in class AbstractSqlLikeQueryBuilder

Parameters:

queryString - The query string

Returns:

The delete clause

isAliasForBatch

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

Description copied from class: AbstractSqlLikeQueryBuilder

Should aliases be used in batch statements.

Overrides:

isAliasForBatch in class SqlQueryBuilder

Parameters:

persistentEntity - the persistent entity

annotationMetadata - the method annotation metadata

Returns:

True if they should

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.

Overrides:

computePropertyPaths in class SqlQueryBuilder

Returns:

True if property path computation is required.

buildInsert

public QueryResult buildInsert(io.micronaut.core.annotation.AnnotationMetadata repositoryMetadata,
 QueryBuilder.InsertQueryDefinition definition)

Description copied from interface: QueryBuilder

Builds an insert statement for the given entity.

Specified by:

buildInsert in interface QueryBuilder

Overrides:

buildInsert in class SqlQueryBuilder

Parameters:

repositoryMetadata - The repository annotation metadata

definition - The definition

Returns:

The insert statement or null if the implementation doesn't require insert statements

buildUpdate

public QueryResult buildUpdate(io.micronaut.core.annotation.AnnotationMetadata annotationMetadata,
 QueryBuilder.UpdateQueryDefinition definition)

Description copied from interface: QueryBuilder

Encode the given query into the encoded query instance.

Specified by:

buildUpdate in interface QueryBuilder

Overrides:

buildUpdate in class AbstractSqlLikeQueryBuilder

Parameters:

annotationMetadata - The annotation metadata

definition - The definition

Returns:

The encoded query

buildLimitAndOffset

public String buildLimitAndOffset(long limit,
 long offset)

Description copied from interface: QueryBuilder

Generate the limit and offset query.

Specified by:

buildLimitAndOffset in interface QueryBuilder

Overrides:

buildLimitAndOffset in class AbstractSqlLikeQueryBuilder

Parameters:

limit - The limit (-1 of not set)

offset - The offset (0 if not set)

Returns:

The encoded query