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

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

Modifier and Type	Class	Description
protected final class	MongoQueryBuilder.QueryState	The state of the query.

Field Summary

Fields

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

Fields inherited from interface io.micronaut.data.model.query.builder.QueryBuilder

VARIABLE_PATTERN

Constructor Summary

Constructors

Constructor	Description
MongoQueryBuilder()

Method Summary

Modifier and Type	Method	Description
QueryResult	buildDelete(io.micronaut.core.annotation.AnnotationMetadata annotationMetadata, QueryModel query)	Encode the given query into the encoded query instance.
QueryResult	buildInsert(io.micronaut.core.annotation.AnnotationMetadata repositoryMetadata, PersistentEntity entity)	Builds an insert statement for the given entity.
QueryResult	buildOrderBy(PersistentEntity entity, Sort sort)	Encode the given query into the encoded query instance.
QueryResult	buildPagination(Pageable pageable)	Encode the pageable.
QueryResult	buildQuery(io.micronaut.core.annotation.AnnotationMetadata annotationMetadata, QueryModel query)	Encode the given query for the passed annotation metadata and query.
QueryResult	buildUpdate(io.micronaut.core.annotation.AnnotationMetadata annotationMetadata, QueryModel query, List<String> propertiesToUpdate)	Encode the given query into the encoded query instance.
QueryResult	buildUpdate(io.micronaut.core.annotation.AnnotationMetadata annotationMetadata, QueryModel query, Map<String,Object> propertiesToUpdate)	Encode the given query into the encoded query instance.

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, buildInsertReturning, buildUpdate, buildUpdate, shouldAliasProjections, supportsForUpdate

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

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 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 interface QueryBuilder

Parameters:

repositoryMetadata - The repository annotation metadata

entity - The entity

Returns:

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

buildQuery

public QueryResult buildQuery(io.micronaut.core.annotation.AnnotationMetadata annotationMetadata,
 QueryModel query)

Description copied from interface: QueryBuilder

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

Specified by:

buildQuery in interface QueryBuilder

Parameters:

annotationMetadata - The annotation metadata

query - The query model

Returns:

The query result

buildUpdate

public QueryResult buildUpdate(io.micronaut.core.annotation.AnnotationMetadata annotationMetadata,
 QueryModel query,
 List<String> propertiesToUpdate)

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

query - The query

propertiesToUpdate - The property names to update

Returns:

The encoded query

buildUpdate

public QueryResult buildUpdate(io.micronaut.core.annotation.AnnotationMetadata annotationMetadata,
 QueryModel query,
 Map<String,Object> propertiesToUpdate)

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

query - The query

propertiesToUpdate - The property names to update

Returns:

The encoded query

buildDelete

public QueryResult buildDelete(io.micronaut.core.annotation.AnnotationMetadata annotationMetadata,
 QueryModel query)

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

query - The query

Returns:

The encoded query

buildOrderBy

public QueryResult buildOrderBy(PersistentEntity entity,
 Sort sort)

Description copied from interface: QueryBuilder

Encode the given query into the encoded query instance.

Specified by:

buildOrderBy in interface QueryBuilder

Parameters:

entity - The root entity

sort - The sort

Returns:

The encoded query

buildPagination

public QueryResult buildPagination(Pageable pageable)

Description copied from interface: QueryBuilder

Encode the pageable.

Specified by:

buildPagination in interface QueryBuilder

Parameters:

pageable - The pageable

Returns:

The encoded query