reactivemongo.api.commands.AggregationFramework

ChangeStream

final class ChangeStream extends PipelineOperator

Low level pipeline operator which allows to open a tailable cursor against subsequent ChangeEvents of a given collection (since MongoDB 3.6). https://docs.mongodb.com/manual/reference/change-events/

For common use-cases, you might prefer to use the watch operator on a collection.

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

Linear Supertypes
AggregationFramework.PipelineOperator, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ChangeStream
  2. PipelineOperator
  3. AnyRef
  4. 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

Instance Constructors

  1. new ChangeStream(resumeAfter: Option[P.Value] = scala.None, startAtOperationTime: Option[P.Value] = scala.None, fullDocumentStrategy: Option[FullDocumentStrategy] = scala.None)

    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)

    fullDocumentStrategy

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

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 ChangeStream to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd

  5. def ->[B](y: B): (ChangeStream, B)

    Implicit information
    This member is added by an implicit conversion from ChangeStream to ArrowAssoc[ChangeStream] 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: (ChangeStream) ⇒ Boolean, msg: ⇒ Any): ChangeStream

    Implicit information
    This member is added by an implicit conversion from ChangeStream to Ensuring[ChangeStream] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  11. def ensuring(cond: (ChangeStream) ⇒ Boolean): ChangeStream

    Implicit information
    This member is added by an implicit conversion from ChangeStream to Ensuring[ChangeStream] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  12. def ensuring(cond: Boolean, msg: ⇒ Any): ChangeStream

    Implicit information
    This member is added by an implicit conversion from ChangeStream to Ensuring[ChangeStream] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  13. def ensuring(cond: Boolean): ChangeStream

    Implicit information
    This member is added by an implicit conversion from ChangeStream to Ensuring[ChangeStream] 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 ChangeStream 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. def makePipe: P.Document

    Definition Classes
    ChangeStream → PipelineOperator

  22. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  23. final def notify(): Unit

    Definition Classes
    AnyRef

  24. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  25. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  26. def toString(): String

    Definition Classes
    AnyRef → Any

  27. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  28. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  29. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  30. def →[B](y: B): (ChangeStream, B)

    Implicit information
    This member is added by an implicit conversion from ChangeStream to ArrowAssoc[ChangeStream] 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 ChangeStream 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:
    (changeStream: StringAdd).self
    Definition Classes
    StringAdd

  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from ChangeStream 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:
    (changeStream: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: ChangeStream

    Implicit information
    This member is added by an implicit conversion from ChangeStream to ArrowAssoc[ChangeStream] 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:
    (changeStream: ArrowAssoc[ChangeStream]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: ChangeStream

    Implicit information
    This member is added by an implicit conversion from ChangeStream to Ensuring[ChangeStream] 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:
    (changeStream: Ensuring[ChangeStream]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from AggregationFramework.PipelineOperator

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ChangeStream to StringAdd

Inherited by implicit conversion any2stringfmt from ChangeStream to StringFormat

Inherited by implicit conversion any2ArrowAssoc from ChangeStream to ArrowAssoc[ChangeStream]

Inherited by implicit conversion any2Ensuring from ChangeStream to Ensuring[ChangeStream]

Ungrouped