Packages

c

org.mongodb.scala

ChangeStreamObservable

case class ChangeStreamObservable[TResult](wrapped: ChangeStreamIterable[TResult]) extends Observable[ChangeStreamDocument[TResult]] with Product with Serializable

Observable 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, the the ChangeStreamObservable#withDocumentClass method should be used to provide an alternative document format.

TResult

The type of the result.

wrapped

the underlying java ChangeStreamIterable

Since

2.2

Note

Requires MongoDB 3.6 or greater

Linear Supertypes
Serializable, Product, Equals, Observable[ChangeStreamDocument[TResult]], com.mongodb.async.client.Observable[ChangeStreamDocument[TResult]], AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ChangeStreamObservable
  2. Serializable
  3. Product
  4. Equals
  5. Observable
  6. Observable
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ChangeStreamObservable(wrapped: ChangeStreamIterable[TResult])

    wrapped

    the underlying java ChangeStreamIterable

Value Members

  1. def batchSize(batchSize: Int): ChangeStreamObservable[TResult]

    Sets the number of documents to return per batch.

    Sets the number of documents to return per batch.

    batchSize

    the batch size

    returns

    this

  2. def collation(collation: Collation): ChangeStreamObservable[TResult]

    Sets the collation options

    Sets the collation options

    A null value represents the server default.

    collation

    the collation options to use

    returns

    this

  3. def fullDocument(fullDocument: FullDocument): ChangeStreamObservable[TResult]

    Sets the fullDocument value.

    Sets the fullDocument value.

    fullDocument

    the fullDocument

    returns

    this

  4. def maxAwaitTime(duration: Duration): ChangeStreamObservable[TResult]

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

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

    Max Time

    duration

    the duration

    returns

    this

  5. def productElementNames: Iterator[String]
    Definition Classes
    Product
  6. def resumeAfter(resumeToken: Document): ChangeStreamObservable[TResult]

    Sets the logical starting point for the new change stream.

    Sets the logical starting point for the new change stream.

    resumeToken

    the resume token

    returns

    this

  7. def startAfter(startAfter: Document): ChangeStreamObservable[TResult]

    Sets the logical starting point for the new change stream.

    Sets the logical starting point for the new change stream.

    This will allow users to watch collections that have been dropped and recreated or newly renamed collections without missing any notifications.

    startAfter

    the resume token

    returns

    this

    Since

    2.7

    Note

    Requires MongoDB 4.2 or greater

    ,

    The server will report an error if both startAfter and resumeAfter are specified.

    See also

    Change stream start after

  8. def startAtOperationTime(startAtOperationTime: BsonTimestamp): ChangeStreamObservable[TResult]

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

    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.

    startAtOperationTime

    the start at operation time

    returns

    this

    Since

    2.4

    Note

    Requires MongoDB 4.0 or greater

  9. def subscribe(observer: Observer[_ >: ChangeStreamDocument[TResult]]): Unit

    Request Observable to start streaming data.

    Request Observable to start streaming data.

    This is a "factory method" and can be called multiple times, each time starting a new Subscription. Each Subscription will work for only a single Observer.

    If the Observable rejects the subscription attempt or otherwise fails it will signal the error via Observer.onError.

    observer

    the Observer that will consume signals from this Observable

    Definition Classes
    ChangeStreamObservable → Observable
  10. def subscribe(observer: com.mongodb.async.client.Observer[_ >: ChangeStreamDocument[TResult]]): Unit

    Handles the automatic boxing of a Java Observable so it conforms to the interface.

    Handles the automatic boxing of a Java Observable so it conforms to the interface.

    observer

    the Observer that will consume signals from this Observable

    Definition Classes
    Observable → Observable
    Note

    Users should not have to implement this method but rather use the Scala Observable.

  11. def withDocumentClass[T](clazz: Class[T]): Observable[T]

    Returns an Observable containing the results of the change stream based on the document class provided.

    Returns an Observable containing the results of the change stream based on the document class provided.

    T

    the result type

    clazz

    the class to use for the raw result.

    returns

    an Observable