Class

reactivemongo.api.commands.AggregationFramework

ChangeStream

Related Doc: package AggregationFramework

Permalink

final class ChangeStream extends PipelineOperator

Low level pipeline operator which allows to open a tailable cursor against subsequent change events of a given collection.

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).

Since

MongoDB 3.6

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 StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

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

    Permalink

    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: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. def +(other: String): String

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

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

    Permalink
    Implicit information
    This member is added by an implicit conversion from ChangeStream to ArrowAssoc[ChangeStream] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

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

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

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

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

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

  11. def ensuring(cond: Boolean): ChangeStream

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

  12. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  13. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  15. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from ChangeStream to StringFormat[ChangeStream] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  16. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  17. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  18. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  19. def makePipe: P.Document

    Permalink
    Definition Classes
    ChangeStream → PipelineOperator

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

    Permalink
    Definition Classes
    AnyRef

  21. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  22. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    AnyRef

  24. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  25. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

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

Inherited from AggregationFramework.PipelineOperator

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ChangeStream to any2stringadd[ChangeStream]

Inherited by implicit conversion StringFormat from ChangeStream to StringFormat[ChangeStream]

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

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

Ungrouped