class CoroutineFindPublisher<T : Any> : CoroutinePublisher<T>
(source)
Coroutine wrapper around CoroutineFindPublisher.
<init> |
Coroutine wrapper around CoroutineFindPublisher. CoroutineFindPublisher(publisher: FindPublisher<T>) |
publisher |
val publisher: FindPublisher<T> |
ascendingSort |
Sets the sort criteria with specified ascending properties to apply to the query. fun ascendingSort(vararg properties: KProperty<*>): CoroutineFindPublisher<T> |
batchSize |
Sets the number of documents to return per batch. fun batchSize(batchSize: Int): CoroutineFindPublisher<T> |
collation |
Sets the collation options fun collation(collation: Collation): CoroutineFindPublisher<T> |
comment |
Sets the comment to the query. A null value means no comment is set. fun comment(comment: String): CoroutineFindPublisher<T> |
cursorType |
Sets the cursor type. fun cursorType(cursorType: CursorType): CoroutineFindPublisher<T> |
descendingSort |
Sets the sort criteria with specified descending properties to apply to the query. fun descendingSort(vararg properties: KProperty<*>): CoroutineFindPublisher<T> |
filter |
Sets the query filter to apply to the query. fun filter(filter: Bson): CoroutineFindPublisher<T> |
first |
Helper to return a publisher limited to the first result. suspend fun first(): T? |
hint |
Sets the hint for which index to use. A null value means no hint is set. fun hint(hint: Bson): CoroutineFindPublisher<T> |
limit |
Sets the limit to apply. fun limit(limit: Int): CoroutineFindPublisher<T> |
max |
Sets the exclusive upper bound for a specific index. A null value means no max is set. fun max(max: Bson): CoroutineFindPublisher<T> |
maxAwaitTime |
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 maxAwaitTime(maxAwaitTime: Long, timeUnit: TimeUnit): CoroutineFindPublisher<T> |
maxTime |
Sets the maximum execution time on the server for this operation. fun maxTime(maxTime: Long, timeUnit: TimeUnit): CoroutineFindPublisher<T> |
min |
Sets the minimum inclusive lower bound for a specific index. A null value means no max is set. fun min(min: Bson): CoroutineFindPublisher<T> |
noCursorTimeout |
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 noCursorTimeout(noCursorTimeout: Boolean): CoroutineFindPublisher<T> |
oplogReplay |
Users should not set this under normal circumstances. fun oplogReplay(oplogReplay: Boolean): CoroutineFindPublisher<T> |
partial |
Get partial results from a sharded cluster if one or more shards are unreachable (instead of throwing an error). fun partial(partial: Boolean): CoroutineFindPublisher<T> |
projection |
Sets a document describing the fields to return for all matching documents. fun projection(projection: Bson): CoroutineFindPublisher<T> fun projection(vararg projections: KProperty<*>): CoroutineFindPublisher<T> |
returnKey |
Sets the returnKey. If true the find operation will return only the index keys in the resulting documents. fun returnKey(returnKey: Boolean): CoroutineFindPublisher<T> |
showRecordId |
Sets the showRecordId. Set to true to add a field fun showRecordId(showRecordId: Boolean): CoroutineFindPublisher<T> |
skip |
Sets the number of documents to skip. fun skip(skip: Int): CoroutineFindPublisher<T> |
sort |
Sets the sort criteria to apply to the query. fun sort(sort: Bson): CoroutineFindPublisher<T> |