com.mongodb.client.FindIterable Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of mongo-java-driver Show documentation
Show all versions of mongo-java-driver Show documentation
The MongoDB Java Driver uber-artifact, containing the legacy driver, the mongodb-driver, mongodb-driver-core, and bson
/*
* Copyright 2008-present MongoDB, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.mongodb.client;
import com.mongodb.CursorType;
import com.mongodb.client.model.Collation;
import com.mongodb.lang.Nullable;
import org.bson.conversions.Bson;
import java.util.concurrent.TimeUnit;
/**
* Iterable for find.
*
* @param The type of the result.
* @since 3.0
*/
public interface FindIterable extends MongoIterable {
/**
* Sets the query filter to apply to the query.
*
* @param filter the filter, which may be null.
* @return this
* @mongodb.driver.manual reference/method/db.collection.find/ Filter
*/
FindIterable filter(@Nullable Bson filter);
/**
* Sets the limit to apply.
*
* @param limit the limit, which may be 0
* @return this
* @mongodb.driver.manual reference/method/cursor.limit/#cursor.limit Limit
*/
FindIterable limit(int limit);
/**
* Sets the number of documents to skip.
*
* @param skip the number of documents to skip
* @return this
* @mongodb.driver.manual reference/method/cursor.skip/#cursor.skip Skip
*/
FindIterable skip(int skip);
/**
* Sets the maximum execution time on the server for this operation.
*
* @param maxTime the max time
* @param timeUnit the time unit, which may not be null
* @return this
* @mongodb.driver.manual reference/method/cursor.maxTimeMS/#cursor.maxTimeMS Max Time
*/
FindIterable maxTime(long maxTime, TimeUnit timeUnit);
/**
* The maximum amount of time for the server to wait on new documents to satisfy a tailable cursor
* query. This only applies to a TAILABLE_AWAIT cursor. When the cursor is not a TAILABLE_AWAIT cursor,
* this option is ignored.
*
* On servers >= 3.2, this option will be specified on the getMore command as "maxTimeMS". The default
* is no value: no "maxTimeMS" is sent to the server with the getMore command.
*
* On servers < 3.2, this option is ignored, and indicates that the driver should respect the server's default value
*
* A zero value will be ignored.
*
* @param maxAwaitTime the max await time
* @param timeUnit the time unit to return the result in
* @return the maximum await execution time in the given time unit
* @mongodb.driver.manual reference/method/cursor.maxTimeMS/#cursor.maxTimeMS Max Time
* @since 3.2
*/
FindIterable maxAwaitTime(long maxAwaitTime, TimeUnit timeUnit);
/**
* Sets the query modifiers to apply to this operation.
*
* @param modifiers the query modifiers to apply, which may be null.
* @return this
* @mongodb.driver.manual reference/operator/query-modifier/ Query Modifiers
* @deprecated use the individual setters instead
*/
@Deprecated
FindIterable modifiers(@Nullable Bson modifiers);
/**
* Sets a document describing the fields to return for all matching documents.
*
* @param projection the project document, which may be null.
* @return this
* @mongodb.driver.manual reference/method/db.collection.find/ Projection
*/
FindIterable projection(@Nullable Bson projection);
/**
* Sets the sort criteria to apply to the query.
*
* @param sort the sort criteria, which may be null.
* @return this
* @mongodb.driver.manual reference/method/cursor.sort/ Sort
*/
FindIterable sort(@Nullable Bson sort);
/**
* The server normally times out idle cursors after an inactivity period (10 minutes)
* to prevent excess memory use. Set this option to prevent that.
*
* @param noCursorTimeout true if cursor timeout is disabled
* @return this
*/
FindIterable noCursorTimeout(boolean noCursorTimeout);
/**
* Users should not set this under normal circumstances.
*
* @param oplogReplay if oplog replay is enabled
* @return this
*/
FindIterable oplogReplay(boolean oplogReplay);
/**
* Get partial results from a sharded cluster if one or more shards are unreachable (instead of throwing an error).
*
* @param partial if partial results for sharded clusters is enabled
* @return this
*/
FindIterable partial(boolean partial);
/**
* Sets the cursor type.
*
* @param cursorType the cursor type
* @return this
*/
FindIterable cursorType(CursorType cursorType);
/**
* Sets the number of documents to return per batch.
*
* @param batchSize the batch size
* @return this
* @mongodb.driver.manual reference/method/cursor.batchSize/#cursor.batchSize Batch Size
*/
@Override
FindIterable batchSize(int batchSize);
/**
* Sets the collation options
*
* A null value represents the server default.
* @param collation the collation options to use
* @return this
* @since 3.4
* @mongodb.server.release 3.4
*/
FindIterable collation(@Nullable Collation collation);
/**
* Sets the comment to the query. A null value means no comment is set.
*
* @param comment the comment
* @return this
* @since 3.5
*/
FindIterable comment(@Nullable String comment);
/**
* Sets the hint for which index to use. A null value means no hint is set.
*
* @param hint the hint
* @return this
* @since 3.5
*/
FindIterable hint(@Nullable Bson hint);
/**
* Sets the exclusive upper bound for a specific index. A null value means no max is set.
*
* @param max the max
* @return this
* @since 3.5
*/
FindIterable max(@Nullable Bson max);
/**
* Sets the minimum inclusive lower bound for a specific index. A null value means no max is set.
*
* @param min the min
* @return this
* @since 3.5
*/
FindIterable min(@Nullable Bson min);
/**
* Sets the maximum number of documents or index keys to scan when executing the query.
*
* A zero value or less will be ignored, and indicates that the driver should respect the server's default value.
*
* @param maxScan the maxScan
* @return this
* @since 3.5
* @deprecated Deprecated as of MongoDB 4.0 release
*/
@Deprecated
FindIterable maxScan(long maxScan);
/**
* Sets the returnKey. If true the find operation will return only the index keys in the resulting documents.
*
* @param returnKey the returnKey
* @return this
* @since 3.5
*/
FindIterable returnKey(boolean returnKey);
/**
* Sets the showRecordId. Set to true to add a field {@code $recordId} to the returned documents.
*
* @param showRecordId the showRecordId
* @return this
* @since 3.5
*/
FindIterable showRecordId(boolean showRecordId);
/**
* Sets the snapshot.
*
* If true it prevents the cursor from returning a document more than once because of an intervening write operation.
*
* @param snapshot the snapshot
* @return this
* @since 3.5
* @deprecated Deprecated in MongoDB 3.6 release and removed in MongoDB 4.0 release
*/
@Deprecated
FindIterable snapshot(boolean snapshot);
}