Packages

c

gnieh.sohva

ChangeStream

class ChangeStream extends AnyRef

A stream that represents a connection to the _changes stream of a database.

Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ChangeStream
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ChangeStream(database: Database)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def all(docIds: Iterable[String] = Vector.empty[String], conflicts: Boolean = false, descending: Boolean = false, filter: Option[String] = None, selector: Option[Selector] = None, designOnly: Boolean = false, includeDocs: Boolean = false, attachments: Boolean = false, attEncodingInfo: Boolean = false, lastEventId: Option[Int] = None, limit: Option[Int] = None, since: Since = Origin, style: Option[String] = None, view: Option[String] = None): Source[Change, UniqueKillSwitch]

    Returns a continuous stream representing the changes in the database.

    Returns a continuous stream representing the changes in the database. Each change produces an element in the stream. The returned stream can be cancelled using the kill switch returned by materializing it. E.g. if you want to log the changes to the console and shut it down after a while, you can write

    val stream = db.changes.stream()
    val killSwitch = stream.toMat(Sink.foreach(println _))(Keep.left).run()
    ...
    killSwitch.shutdown()
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  7. def current(docIds: Iterable[String] = Vector.empty[String], conflicts: Boolean = false, descending: Boolean = false, filter: Option[String] = None, selector: Option[Selector] = None, designOnly: Boolean = false, includeDocs: Boolean = false, attachments: Boolean = false, attEncodingInfo: Boolean = false, lastEventId: Option[Int] = None, limit: Option[Int] = None, since: Since = Origin, style: Option[String] = None, view: Option[String] = None): Future[Changes]

    Returns a one-shot view of changes for this database.

  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  18. def toString(): String
    Definition Classes
    ChangeStream → AnyRef → Any
  19. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Deprecated Value Members

  1. def once(docIds: Iterable[String] = Vector.empty[String], conflicts: Boolean = false, descending: Boolean = false, filter: Option[String] = None, selector: Option[Selector] = None, designOnly: Boolean = false, includeDocs: Boolean = false, attachments: Boolean = false, attEncodingInfo: Boolean = false, lastEventId: Option[Int] = None, limit: Option[Int] = None, since: Option[Either[String, JsValue]] = None, style: Option[String] = None, view: Option[String] = None): Future[Changes]

    Returns a one-shot view of changes for this database.

    Returns a one-shot view of changes for this database.

    Annotations
    @deprecated
    Deprecated

    (Since version Sohva 2.2.0) Use the current stream instead.

  2. def stream(docIds: Iterable[String] = Vector.empty[String], conflicts: Boolean = false, descending: Boolean = false, filter: Option[String] = None, selector: Option[Selector] = None, designOnly: Boolean = false, includeDocs: Boolean = false, attachments: Boolean = false, attEncodingInfo: Boolean = false, lastEventId: Option[Int] = None, limit: Option[Int] = None, since: Option[Either[String, JsValue]] = None, style: Option[String] = None, view: Option[String] = None): Source[Change, UniqueKillSwitch]

    Returns a continuous stream representing the changes in the database.

    Returns a continuous stream representing the changes in the database. Each change produces an element in the stream. The returned stream can be cancelled using the kill switch returned by materializing it. E.g. if you want to log the changes to the console and shut it down after a while, you can write

    val stream = db.changes.stream()
    val killSwitch = stream.toMat(Sink.foreach(println _))(Keep.left).run()
    ...
    killSwitch.shutdown()
    Annotations
    @deprecated
    Deprecated

    (Since version Sohva 2.2.0) Use the all stream instead.

Inherited from AnyRef

Inherited from Any

Ungrouped