reactivemongo.api.collections

ChangeStreamOps

trait ChangeStreamOps[P <: SerializationPack with Singleton] extends AnyRef

Self Type
GenericCollection[P]
Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ChangeStreamOps
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. sealed trait WatchBuilder[T] extends AnyRef

    A builder for the watch collection helper, which allows to consume the collection's ChangeStream.

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from ChangeStreamOps[P] to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (ChangeStreamOps[P], B)

    Implicit information
    This member is added by an implicit conversion from ChangeStreamOps[P] to ArrowAssoc[ChangeStreamOps[P]] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def ensuring(cond: (ChangeStreamOps[P]) ⇒ Boolean, msg: ⇒ Any): ChangeStreamOps[P]

    Implicit information
    This member is added by an implicit conversion from ChangeStreamOps[P] to Ensuring[ChangeStreamOps[P]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (ChangeStreamOps[P]) ⇒ Boolean): ChangeStreamOps[P]

    Implicit information
    This member is added by an implicit conversion from ChangeStreamOps[P] to Ensuring[ChangeStreamOps[P]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: ⇒ Any): ChangeStreamOps[P]

    Implicit information
    This member is added by an implicit conversion from ChangeStreamOps[P] to Ensuring[ChangeStreamOps[P]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): ChangeStreamOps[P]

    Implicit information
    This member is added by an implicit conversion from ChangeStreamOps[P] to Ensuring[ChangeStreamOps[P]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  15. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  16. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from ChangeStreamOps[P] to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  18. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  19. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  20. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  21. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  22. final def notify(): Unit

    Definition Classes
    AnyRef
  23. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  24. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  25. def toString(): String

    Definition Classes
    AnyRef → Any
  26. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def watch[T](resumeAfter: Option[P.Value] = None, startAtOperationTime: Option[P.Value] = None, pipeline: List[PipelineOperator] = Nil, maxAwaitTimeMS: Option[Long] = None, fullDocumentStrategy: Option[FullDocumentStrategy] = None)(implicit reader: P.Reader[T]): GenericCollection.WatchBuilder[T]

    Prepares a builder for watching the change stream of this collection.

    Prepares a builder for watching the change stream of this collection.

    Note: The target mongo instance MUST be a replica-set (even in the case of a single node deployement).

    import scala.concurrent.{ ExecutionContext, Future }
    
    import reactivemongo.api.Cursor
    import reactivemongo.api.bson.BSONDocument
    import reactivemongo.api.bson.collection.BSONCollection
    
    def events(coll: BSONCollection)(
      implicit ec: ExecutionContext): Cursor[BSONDocument] =
      coll.watch[BSONDocument]().cursor
    T

    the type into which Change Events are deserialized

    resumeAfter

    The id of the last known Change Event, if any. The stream will resume just after that event.

    startAtOperationTime

    The operation time before which all Change Events are known. Must be in the time range of the oplog. (since MongoDB 4.0)

    pipeline

    The sequence of aggregation stages to apply on events in the stream (see MongoDB documentation for a list of valid stages for a change stream).

    maxAwaitTimeMS

    The maximum amount of time in milliseconds the server waits for new data changes before returning an empty batch. In practice, this parameter controls the duration of the long-polling behavior of the cursor.

    fullDocumentStrategy

    if set to UpdateLookup, every update change event will be joined with the current version of the relevant document.

    reader

    the reader of the resulting change events

    Since

    MongoDB 3.6

  30. def [B](y: B): (ChangeStreamOps[P], B)

    Implicit information
    This member is added by an implicit conversion from ChangeStreamOps[P] to ArrowAssoc[ChangeStreamOps[P]] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from ChangeStreamOps[P] to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (changeStreamOps: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from ChangeStreamOps[P] to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (changeStreamOps: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: ChangeStreamOps[P]

    Implicit information
    This member is added by an implicit conversion from ChangeStreamOps[P] to ArrowAssoc[ChangeStreamOps[P]] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (changeStreamOps: ArrowAssoc[ChangeStreamOps[P]]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: ChangeStreamOps[P]

    Implicit information
    This member is added by an implicit conversion from ChangeStreamOps[P] to Ensuring[ChangeStreamOps[P]] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (changeStreamOps: Ensuring[ChangeStreamOps[P]]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ChangeStreamOps[P] to StringAdd

Inherited by implicit conversion any2stringfmt from ChangeStreamOps[P] to StringFormat

Inherited by implicit conversion any2ArrowAssoc from ChangeStreamOps[P] to ArrowAssoc[ChangeStreamOps[P]]

Inherited by implicit conversion any2Ensuring from ChangeStreamOps[P] to Ensuring[ChangeStreamOps[P]]

Ungrouped