mongodb-driver-kotlin-coroutine/com.mongodb.kotlin.client.coroutine/FindFlow

FindFlow

class FindFlow<T : Any>(wrapped: FindPublisher<T>) : Flow<T>

Flow implementation for find operations.

Parameters

T

The type of the result.

See also

Collection filter

Constructors

constructor(wrapped: FindPublisher<T>)

Functions

fun allowDiskUse(allowDiskUse: Boolean?): FindFlow<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.

fun batchSize(batchSize: Int): FindFlow<T>

Sets the number of documents to return per batch.

fun collation(collation: Collation?): FindFlow<T>

Sets the collation options

open suspend override fun collect(collector: FlowCollector<T>)

fun comment(comment: String?): FindFlow<T>

fun comment(comment: BsonValue?): FindFlow<T>

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

fun cursorType(cursorType: CursorType): FindFlow<T>

Sets the cursor type.

@JvmName(name = "explainDocument")

suspend fun explain(verbosity: ExplainVerbosity? = null): Document

inline suspend fun <R : Any> explain(verbosity: ExplainVerbosity? = null): R

suspend fun <R : Any> explain(resultClass: Class<R>, verbosity: ExplainVerbosity? = null): R

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

fun filter(filter: Bson?): FindFlow<T>

Sets the query filter to apply to the query.

fun hint(hint: Bson?): FindFlow<T>

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

fun hintString(hint: String?): FindFlow<T>

Sets the hint to apply.

fun let(variables: Bson?): FindFlow<T>

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

fun limit(limit: Int): FindFlow<T>

Sets the limit to apply.

fun max(max: Bson?): FindFlow<T>

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

fun maxAwaitTime(maxAwaitTime: Long, timeUnit: TimeUnit = TimeUnit.MILLISECONDS): FindFlow<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.

fun maxTime(maxTime: Long, timeUnit: TimeUnit = TimeUnit.MILLISECONDS): FindFlow<T>

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

fun min(min: Bson?): FindFlow<T>

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

noCursorTimeout

fun noCursorTimeout(noCursorTimeout: Boolean): FindFlow<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.

fun ~~oplogReplay~~(oplogReplay: Boolean): FindFlow<T>

Users should not set this under normal circumstances.

fun partial(partial: Boolean): FindFlow<T>

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

fun projection(projection: Bson?): FindFlow<T>

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

fun returnKey(returnKey: Boolean): FindFlow<T>

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

fun showRecordId(showRecordId: Boolean): FindFlow<T>

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

fun skip(skip: Int): FindFlow<T>

Sets the number of documents to skip.

fun sort(sort: Bson?): FindFlow<T>

Sets the sort criteria to apply to the query.