kmongo / org.litote.kmongo.coroutine / CoroutineMapReducePublisher

CoroutineMapReducePublisher

class CoroutineMapReducePublisher<T : Any> : CoroutinePublisher<T> (source)

Coroutine wrapper around MapReducePublisher.

Constructors

<init>

Coroutine wrapper around MapReducePublisher.

CoroutineMapReducePublisher(publisher: MapReducePublisher<T>)

Properties

publisher

val publisher: MapReducePublisher<T>

Functions

action

Specify the MapReduceAction to be used when writing to a collection.

fun action(action: MapReduceAction): CoroutineMapReducePublisher<T>

batchSize

Sets the number of documents to return per batch.

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

bypassDocumentValidation

Sets the bypass document level validation flag.

fun bypassDocumentValidation(bypassDocumentValidation: Boolean?): CoroutineMapReducePublisher<T>

collation

Sets the collation options

fun collation(collation: Collation): CoroutineMapReducePublisher<T>

collectionName

Sets the collectionName for the output of the MapReduce

fun collectionName(collectionName: String): CoroutineMapReducePublisher<T>

databaseName

Sets the name of the database to output into.

fun databaseName(databaseName: String): CoroutineMapReducePublisher<T>

filter

Sets the query filter to apply to the query.

fun filter(filter: Bson): CoroutineMapReducePublisher<T>

finalizeFunction

Sets the JavaScript function that follows the reduce method and modifies the output.

fun finalizeFunction(finalizeFunction: String): CoroutineMapReducePublisher<T>

first

Helper to return a publisher limited to the first result.

suspend fun first(): T?

jsMode

Sets the flag that specifies whether to convert intermediate data into BSON format between the execution of the map and reduce functions. Defaults to false.

fun jsMode(jsMode: Boolean): CoroutineMapReducePublisher<T>

limit

Sets the limit to apply.

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

maxTime

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

fun maxTime(maxTime: Long, timeUnit: TimeUnit): CoroutineMapReducePublisher<T>

nonAtomic

Sets if the post-processing step will prevent MongoDB from locking the database.

fun nonAtomic(nonAtomic: Boolean): CoroutineMapReducePublisher<T>

scope

Sets the global variables that are accessible in the map, reduce and finalize functions.

fun scope(scope: Bson): CoroutineMapReducePublisher<T>

sharded

Sets if the output database is sharded

fun sharded(sharded: Boolean): CoroutineMapReducePublisher<T>

sort

Sets the sort criteria to apply to the query.

fun sort(sort: Bson): CoroutineMapReducePublisher<T>

toCollection

Aggregates documents to a collection according to the specified map-reduce function with the given options, which must specify a non-inline result.

suspend fun toCollection(): <ERROR CLASS>

verbose

Sets whether to include the timing information in the result information.

fun verbose(verbose: Boolean): CoroutineMapReducePublisher<T>