Class MongoQueryBuilder

java.lang.Object

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

All Implemented Interfaces:

QueryBuilder

@Internal
public final class MongoQueryBuilder
extends Object
implements QueryBuilder

The Mongo query builder.

Since:

3.3

Author:

Denis Stepanov

Nested Class Summary

Nested classes/interfaces inherited from interface QueryBuilder

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MONGO_DATE_IDENTIFIER
static final String	MONGO_ID_FIELD
static final String	NEGATE
static final String	QUERY_PARAMETER_PLACEHOLDER	An object with this property is replaced with an actual query parameter at the runtime.
static final String	RECIPROCATE

Constructor Summary

Constructors

Constructor	Description
MongoQueryBuilder()

Method Summary

Modifier and Type	Method	Description
QueryResult	buildDelete(io.micronaut.core.annotation.AnnotationMetadata annotationMetadata, QueryBuilder.DeleteQueryDefinition queryDefinition)	Encode the given query into the encoded query instance.
@Nullable QueryResult	buildInsert(io.micronaut.core.annotation.AnnotationMetadata repositoryMetadata, QueryBuilder.InsertQueryDefinition insertQueryDefinition)	Builds an insert statement for the given entity.
String	buildLimitAndOffset(long limit, long offset)	Generate the limit and offset query.
QueryResult	buildSelect(io.micronaut.core.annotation.AnnotationMetadata annotationMetadata, QueryBuilder.SelectQueryDefinition selectQueryDefinition)	Encode the given query for the passed annotation metadata and query.
QueryResult	buildUpdate(io.micronaut.core.annotation.AnnotationMetadata annotationMetadata, QueryBuilder.UpdateQueryDefinition updateQueryDefinition)	Encode the given query into the encoded query instance.

Methods inherited from class Object

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

Methods inherited from interface QueryBuilder

buildUpsert

Field Details

QUERY_PARAMETER_PLACEHOLDER

public static final String QUERY_PARAMETER_PLACEHOLDER

An object with this property is replaced with an actual query parameter at the runtime.

See Also:

• Constant Field Values

NEGATE

public static final String NEGATE

See Also:

• Constant Field Values

RECIPROCATE

public static final String RECIPROCATE

See Also:

• Constant Field Values

MONGO_DATE_IDENTIFIER

public static final String MONGO_DATE_IDENTIFIER

See Also:

• Constant Field Values

MONGO_ID_FIELD

public static final String MONGO_ID_FIELD

See Also:

• Constant Field Values

Constructor Details

MongoQueryBuilder

public MongoQueryBuilder()

Method Details

buildInsert

public @Nullable QueryResult buildInsert(io.micronaut.core.annotation.AnnotationMetadata repositoryMetadata,
 QueryBuilder.InsertQueryDefinition insertQueryDefinition)

Description copied from interface: QueryBuilder

Builds an insert statement for the given entity.

Specified by:

buildInsert in interface QueryBuilder

Parameters:

repositoryMetadata - The repository annotation metadata

insertQueryDefinition - The definition

Returns:

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

buildSelect

public QueryResult buildSelect(io.micronaut.core.annotation.AnnotationMetadata annotationMetadata,
 QueryBuilder.SelectQueryDefinition selectQueryDefinition)

Description copied from interface: QueryBuilder

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

Specified by:

buildSelect in interface QueryBuilder

Parameters:

annotationMetadata - The annotation metadata

selectQueryDefinition - The query model

Returns:

The query result

buildUpdate

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

Description copied from interface: QueryBuilder

Encode the given query into the encoded query instance.

Specified by:

buildUpdate in interface QueryBuilder

Parameters:

annotationMetadata - The annotation metadata

updateQueryDefinition - The definition

Returns:

The encoded query

buildDelete

public QueryResult buildDelete(io.micronaut.core.annotation.AnnotationMetadata annotationMetadata,
 QueryBuilder.DeleteQueryDefinition queryDefinition)

Description copied from interface: QueryBuilder

Encode the given query into the encoded query instance.

Specified by:

buildDelete in interface QueryBuilder

Parameters:

annotationMetadata - The annotation metadata

queryDefinition - The query 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

Parameters:

limit - The limit (-1 of not set)

offset - The offset (0 if not set)

Returns:

The encoded query