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

ChangeStreamIterable

class ChangeStreamIterable<T : Any>(wrapped: ChangeStreamIterable<T>) : MongoIterable<ChangeStreamDocument<T>>

Iterable like implementation for change streams.

Note: the ChangeStreamDocument class will not be applicable for all change stream outputs. If using custom pipelines that radically change the result, then the withDocumentClass method can be used to provide an alternative document format.

Parameters

The type of the result.

Constructors

ChangeStreamIterable

constructor(wrapped: ChangeStreamIterable<T>)

Functions

batchSize

open override fun batchSize(batchSize: Int): ChangeStreamIterable<T>

Sets the number of documents to return per batch.

collation

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

Sets the collation options

comment

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

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

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

cursor

open override fun cursor(): MongoChangeStreamCursor<ChangeStreamDocument<T>>

Returns a cursor used for iterating over elements of type {@code ChangeStreamDocument}. The cursor has a covariant return type to additionally provide a method to access the resume token in change stream batches.

first

fun first(): ChangeStreamDocument<T>

firstOrNull

fun firstOrNull(): ChangeStreamDocument<T>?

forEach

fun forEach(action: (ChangeStreamDocument<T>) -> Unit)

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

fullDocument

fun fullDocument(fullDocument: FullDocument): ChangeStreamIterable<T>

Sets the fullDocument value.

fullDocumentBeforeChange

fun fullDocumentBeforeChange(fullDocumentBeforeChange: FullDocumentBeforeChange): ChangeStreamIterable<T>

Sets the fullDocumentBeforeChange value.

map

fun <R> map(transform: (ChangeStreamDocument<T>) -> R): MongoIterable<R>

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

maxAwaitTime

fun maxAwaitTime(maxAwaitTime: Long, timeUnit: TimeUnit = TimeUnit.MILLISECONDS): ChangeStreamIterable<T>

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

resumeAfter

fun resumeAfter(resumeToken: BsonDocument): ChangeStreamIterable<T>

Sets the logical starting point for the new change stream.

showExpandedEvents

fun showExpandedEvents(showExpandedEvents: Boolean): ChangeStreamIterable<T>

Sets whether to include expanded change stream events, which are: createIndexes, dropIndexes, modify, create, shardCollection, reshardCollection, refineCollectionShardKey. False by default.

startAfter

fun startAfter(startAfter: BsonDocument): ChangeStreamIterable<T>

Similar to resumeAfter, this option takes a resume token and starts a new change stream returning the first notification after the token.

startAtOperationTime

fun startAtOperationTime(startAtOperationTime: BsonTimestamp): ChangeStreamIterable<T>

The change stream will only provide changes that occurred at or after the specified timestamp.

toCollection

fun <C : MutableCollection<in ChangeStreamDocument<T>>> toCollection(destination: C): C

Appends all elements to the given destination collection.

toList

fun toList(): List<ChangeStreamDocument<T>>

use

fun <R> use(consumer: (Sequence<ChangeStreamDocument<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.

withDocumentClass

inline fun <R : Any> withDocumentClass(): MongoIterable<R>

fun <R : Any> withDocumentClass(resultClass: Class<R>): MongoIterable<R>

Returns a MongoIterable containing the results of the change stream based on the document class provided.