Package com.mongodb.async.client

Interface ChangeStreamIterable<TResult>

  • Type Parameters:
    TResult - The type of the result.
    All Superinterfaces:
    MongoIterable<ChangeStreamDocument<TResult>>
    Deprecated. 
    Prefer the Reactive Streams-based asynchronous driver (mongodb-driver-reactivestreams artifactId)

    @Deprecated
public interface ChangeStreamIterable<TResult>
extends MongoIterable<ChangeStreamDocument<TResult>>
    Iterable 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(Class) method can be used to provide an alternative document format.

    Since:
    3.6
    Since server release
    3.6

    • Method Detail

      • resumeAfter

        ChangeStreamIterable<TResult> resumeAfter​(BsonDocument resumeToken)
        Deprecated. 
        Sets the logical starting point for the new change stream.
        Parameters:
        resumeToken - the resume token
        Returns:
        this

      • maxAwaitTime

        ChangeStreamIterable<TResult> maxAwaitTime​(long maxAwaitTime,
                                           TimeUnit timeUnit)
        Deprecated. 
        Sets the maximum await execution time on the server for this operation.
        Parameters:
        maxAwaitTime - the max await time. A zero value will be ignored, and indicates that the driver should respect the server's default value
        timeUnit - the time unit, which may not be null
        Returns:
        this

      • collation

        ChangeStreamIterable<TResult> collation​(@Nullable
                                        Collation collation)
        Deprecated. 
        Sets the collation options

        A null value represents the server default.

        Parameters:
        collation - the collation options to use
        Returns:
        this

      • withDocumentClass

        <TDocument> MongoIterable<TDocument> withDocumentClass​(Class<TDocument> clazz)
        Deprecated. 
        Returns a MongoIterable containing the results of the change stream based on the document class provided.
        Type Parameters:
        TDocument - the result type
        Parameters:
        clazz - the class to use for the raw result.
        Returns:
        the new Mongo Iterable

      • startAtOperationTime

        ChangeStreamIterable<TResult> startAtOperationTime​(BsonTimestamp startAtOperationTime)
        Deprecated. 
        The change stream will only provide changes that occurred at or after the specified timestamp.

        Any command run against the server will return an operation time that can be used here.

        The default value is an operation time obtained from the server before the change stream was created.

        Parameters:
        startAtOperationTime - the start at operation time
        Returns:
        this
        Since:
        3.8
        MongoDB documentation
        reference/method/db.runCommand/
        Since server release
        4.0