mongodb-driver-kotlin-sync/com.mongodb.kotlin.client/FindIterable

FindIterable

class FindIterable<T : Any>(wrapped: FindIterable<T>) : MongoIterable<T>

Iterable like implementation for find operations.

Parameters

T

The type of the result.

See also

Constructors

Link copied to clipboard
constructor(wrapped: FindIterable<T>)

Functions

Link copied to clipboard
fun allowDiskUse(allowDiskUse: Boolean?): FindIterable<T>

Enables writing to temporary files on the server. When set to true, the server can write temporary data to disk while executing the find operation.

Link copied to clipboard
open override fun batchSize(batchSize: Int): FindIterable<T>

Sets the number of documents to return per batch.

Link copied to clipboard
fun collation(collation: Collation?): FindIterable<T>

Sets the collation options

Link copied to clipboard
fun comment(comment: String?): FindIterable<T>
fun comment(comment: BsonValue?): FindIterable<T>

Sets the comment for this operation. A null value means no comment is set.

Link copied to clipboard
open fun cursor(): MongoCursor<T>

Returns a cursor used for iterating over elements of type `T. The cursor is primarily used for change streams.

Link copied to clipboard
fun cursorType(cursorType: CursorType): FindIterable<T>

Sets the cursor type.

Link copied to clipboard
fun explain(verbosity: ExplainVerbosity? = null): Document
inline fun <R : Any> explain(verbosity: ExplainVerbosity? = null): R
fun <R : Any> explain(resultClass: Class<R>, verbosity: ExplainVerbosity? = null): R

Explain the execution plan for this operation with the given verbosity level

Link copied to clipboard
fun filter(filter: Bson?): FindIterable<T>

Sets the query filter to apply to the query.

Link copied to clipboard
fun first(): T
Link copied to clipboard
fun firstOrNull(): T?
Link copied to clipboard
fun forEach(action: (T) -> Unit)

Performs the given action on each element and safely closes the cursor.

Link copied to clipboard
fun hint(hint: Bson?): FindIterable<T>

Sets the hint for which index to use. A null value means no hint is set.

Link copied to clipboard
fun hintString(hint: String?): FindIterable<T>

Sets the hint to apply.

Link copied to clipboard
fun let(variables: Bson?): FindIterable<T>

Add top-level variables to the operation. A null value means no variables are set.

Link copied to clipboard
fun limit(limit: Int): FindIterable<T>

Sets the limit to apply.

Link copied to clipboard
fun <R> map(transform: (T) -> R): MongoIterable<R>

Maps this iterable from the source document type to the target document type.

Link copied to clipboard
fun max(max: Bson?): FindIterable<T>

Sets the exclusive upper bound for a specific index. A null value means no max is set.

Link copied to clipboard
fun maxAwaitTime(maxAwaitTime: Long, timeUnit: TimeUnit = TimeUnit.MILLISECONDS): FindIterable<T>

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.

Link copied to clipboard
fun maxTime(maxTime: Long, timeUnit: TimeUnit = TimeUnit.MILLISECONDS): FindIterable<T>

Sets the maximum execution time on the server for this operation.

Link copied to clipboard
fun min(min: Bson?): FindIterable<T>

Sets the minimum inclusive lower bound for a specific index. A null value means no max is set.

Link copied to clipboard
fun noCursorTimeout(noCursorTimeout: Boolean): FindIterable<T>

The server normally times out idle cursors after an inactivity period (10 minutes) to prevent excess memory use. Set this option to prevent that.

Link copied to clipboard
fun partial(partial: Boolean): FindIterable<T>

Get partial results from a sharded cluster if one or more shards are unreachable (instead of throwing an error).

Link copied to clipboard
fun projection(projection: Bson?): FindIterable<T>

Sets a document describing the fields to return for all matching documents.

Link copied to clipboard
fun returnKey(returnKey: Boolean): FindIterable<T>

Sets the returnKey. If true the find operation will return only the index keys in the resulting documents.

Link copied to clipboard
fun showRecordId(showRecordId: Boolean): FindIterable<T>

Sets the showRecordId. Set to true to add a field $recordId to the returned documents.

Link copied to clipboard
fun skip(skip: Int): FindIterable<T>

Sets the number of documents to skip.

Link copied to clipboard
fun sort(sort: Bson?): FindIterable<T>

Sets the sort criteria to apply to the query.

Link copied to clipboard
@Alpha(value = [Reason.CLIENT])
fun timeoutMode(timeoutMode: TimeoutMode): FindIterable<T>

Sets the timeoutMode for the cursor.

Link copied to clipboard
fun <C : MutableCollection<in T>> toCollection(destination: C): C

Appends all elements to the given destination collection.

Link copied to clipboard
fun toList(): List<T>
Link copied to clipboard
fun <R> use(consumer: (Sequence<T>) -> R): R

Creates a new cursor and treats it as a Sequence, invokes the given consumer function and closes the cursor down correctly whether an exception is thrown or not.