org.springframework.data.mongodb.core.query

Class Query

java.lang.Object

org.springframework.data.mongodb.core.query.Query

Direct Known Subclasses:

BasicQuery, TextQuery

public class Query
extends Object

MongoDB Query object representing criteria, projection, sorting and query hints.

Author:

Thomas Risberg, Oliver Gierke, Thomas Darimont, Christoph Strobl, Mark Paluch

Constructor Summary

Constructors

Constructor and Description
Query()
Query(CriteriaDefinition criteriaDefinition) Creates a new Query using the given CriteriaDefinition.

Method Summary

Modifier and Type	Method and Description
Query	addCriteria(CriteriaDefinition criteriaDefinition) Adds the given CriteriaDefinition to the current Query.
Query	collation(Collation collation) Set the Collation applying language-specific rules for string comparison.
Query	comment(String comment) Add a comment to the query that is propagated to the profile log.
Query	cursorBatchSize(int batchSize) Set the number of documents to return in each response batch.
boolean	equals(Object obj)
Query	exhaust()
Field	fields()
Optional<Collation>	getCollation() Get the Collation defining language-specific rules for string comparison.
protected List<CriteriaDefinition>	getCriteria()
org.bson.Document	getFieldsObject()
String	getHint()
int	getLimit() Get the maximum number of documents to be return.
Meta	getMeta()
org.bson.Document	getQueryObject()
Set<Class<?>>	getRestrictedTypes()
long	getSkip() Get the number of documents to skip.
org.bson.Document	getSortObject()
int	hashCode()
static boolean	isRestrictedTypeKey(String key) Deprecated. don't call this method as the restricted type handling will undergo some significant changes going forward.
Query	limit(int limit) Limit the number of returned documents to limit.
Query	maxScan(long maxScan) Deprecated. since 2.1 due to deprecation in MongoDB 4.0.
Query	maxTime(Duration timeout)
Query	maxTime(long timeout, TimeUnit timeUnit) Deprecated. since 2.1. Use maxTime(Duration) instead.
Query	maxTimeMsec(long maxTimeMsec)
Query	noCursorTimeout()
Query	partialResults()
static Query	query(CriteriaDefinition criteriaDefinition) Static factory method to create a Query using the provided CriteriaDefinition.
protected boolean	querySettingsEquals(Query that) Tests whether the settings of the given Query are equal to this query.
Query	restrict(Class<?> type, Class<?>... additionalTypes) Restricts the query to only return documents instances that are exactly of the given types.
void	setMeta(Meta meta)
Query	skip(long skip) Set number of documents to skip before returning results.
Query	slaveOk() Allows querying of a replica slave.
String	toString()
Query	useSnapshot() Deprecated. since 2.1 due to deprecation as of MongoDB 3.6
Query	with(Pageable pageable) Sets the given pagination information on the Query instance.
Query	with(Sort sort) Adds a Sort to the Query instance.
Query	withHint(String name) Configures the query to use the given hint when being executed.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Query

public Query()

Query

public Query(CriteriaDefinition criteriaDefinition)

Creates a new Query using the given CriteriaDefinition.

Parameters:

criteriaDefinition - must not be null.

Since:

1.6

Method Detail

query

public static Query query(CriteriaDefinition criteriaDefinition)

Static factory method to create a Query using the provided CriteriaDefinition.

Parameters:

criteriaDefinition - must not be null.

Returns:

Since:

1.6

addCriteria

public Query addCriteria(CriteriaDefinition criteriaDefinition)

Adds the given CriteriaDefinition to the current Query.

Parameters:

criteriaDefinition - must not be null.

Returns:

Since:

1.6

fields

public Field fields()

skip

public Query skip(long skip)

Set number of documents to skip before returning results.

Parameters:

skip -

Returns:

limit

public Query limit(int limit)

Limit the number of returned documents to limit.

Parameters:

limit -

Returns:

withHint

public Query withHint(String name)

Configures the query to use the given hint when being executed.

Parameters:

name - must not be null or empty.

Returns:

with

public Query with(Pageable pageable)

Sets the given pagination information on the Query instance. Will transparently set skip and limit as well as applying the Sort instance defined with the Pageable.

Parameters:

pageable -

Returns:

with

public Query with(Sort sort)

Adds a Sort to the Query instance.

Parameters:

sort -

Returns:

getRestrictedTypes

public Set<Class<?>> getRestrictedTypes()

Returns:

the restrictedTypes

restrict

public Query restrict(Class<?> type,
                      Class<?>... additionalTypes)

Restricts the query to only return documents instances that are exactly of the given types.

Parameters:

type - may not be null

additionalTypes - may not be null

Returns:

getQueryObject

public org.bson.Document getQueryObject()

Returns:

the query Document.

getFieldsObject

public org.bson.Document getFieldsObject()

Returns:

the field Document.

getSortObject

public org.bson.Document getSortObject()

Returns:

the sort Document.

getSkip

public long getSkip()

Get the number of documents to skip.

Returns:

getLimit

public int getLimit()

Get the maximum number of documents to be return.

Returns:

getHint

@Nullable
public String getHint()

Returns:

maxTimeMsec

public Query maxTimeMsec(long maxTimeMsec)

Parameters:

maxTimeMsec -

Returns:

this.

Since:

1.6

See Also:

Meta.setMaxTimeMsec(long)

maxTime

@Deprecated
public Query maxTime(long timeout,
                                 TimeUnit timeUnit)

Deprecated. since 2.1. Use maxTime(Duration) instead.

Parameters:

timeout -

timeUnit -

Returns:

this.

Since:

1.6

See Also:

Meta.setMaxTime(long, TimeUnit)

maxTime

public Query maxTime(Duration timeout)

Parameters:

timeout -

Returns:

this.

Since:

2.1

See Also:

Meta.setMaxTime(Duration)

maxScan

@Deprecated
public Query maxScan(long maxScan)

Deprecated. since 2.1 due to deprecation in MongoDB 4.0.

Parameters:

maxScan -

Returns:

this.

Since:

1.6

See Also:

Meta.setMaxScan(long)

comment

public Query comment(String comment)

Add a comment to the query that is propagated to the profile log.

Parameters:

comment -

Returns:

this.

Since:

1.6

See Also:

Meta.setComment(String)

useSnapshot

@Deprecated
public Query useSnapshot()

Deprecated. since 2.1 due to deprecation as of MongoDB 3.6

Returns:

this.

Since:

1.6

See Also:

Meta.setSnapshot(boolean)

cursorBatchSize

public Query cursorBatchSize(int batchSize)

Set the number of documents to return in each response batch.
Use 0 (zero) for no limit. A negative limit closes the cursor after returning a single batch indicating to the server that the client will not ask for a subsequent one.

Parameters:

batchSize - The number of documents to return per batch.

Returns:

this.

Since:

2.1

See Also:

Meta.setCursorBatchSize(int)

noCursorTimeout

public Query noCursorTimeout()

Returns:

this.

Since:

1.10

See Also:

Meta.CursorOption.NO_TIMEOUT

exhaust

public Query exhaust()

Returns:

this.

Since:

1.10

See Also:

Meta.CursorOption.EXHAUST

slaveOk

public Query slaveOk()

Allows querying of a replica slave.

Returns:

this.

Since:

1.10

See Also:

Meta.CursorOption.SLAVE_OK

partialResults

public Query partialResults()

Returns:

this.

Since:

1.10

See Also:

Meta.CursorOption.PARTIAL

getMeta

public Meta getMeta()

Returns:

never null.ø

Since:

1.6

setMeta

public void setMeta(Meta meta)

Parameters:

meta - must not be null.

Since:

1.6

collation

public Query collation(@Nullable
                       Collation collation)

Set the Collation applying language-specific rules for string comparison.

Parameters:

collation - can be null.

Returns:

Since:

2.0

getCollation

public Optional<Collation> getCollation()

Get the Collation defining language-specific rules for string comparison.

Returns:

Since:

2.0

getCriteria

protected List<CriteriaDefinition> getCriteria()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

querySettingsEquals

protected boolean querySettingsEquals(Query that)

Tests whether the settings of the given Query are equal to this query.

Parameters:

that -

Returns:

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isRestrictedTypeKey

@Deprecated
public static boolean isRestrictedTypeKey(String key)

Deprecated. don't call this method as the restricted type handling will undergo some significant changes going forward.

Returns whether the given key is the one used to hold the type restriction information.

Parameters:

key -

Returns: