Packages

c

mongo4cats.collection.queries

WatchQueryBuilder

final case class WatchQueryBuilder[F[_], T] extends QueryBuilder[ChangeStreamPublisher, T] with Product with Serializable

Linear Supertypes
Serializable, Product, Equals, QueryBuilder[ChangeStreamPublisher, T], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WatchQueryBuilder
  2. Serializable
  3. Product
  4. Equals
  5. QueryBuilder
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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 applyCommands(): ChangeStreamPublisher[T]
    Attributes
    protected
    Definition Classes
    QueryBuilder
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def batchSize(size: Int): WatchQueryBuilder[F, T]

    Sets the number of documents to return per batch.

    Sets the number of documents to return per batch.

    Overrides the Subscription#request value for setting the batch size, allowing for fine grained control over the underlying cursor.

    size

    the batch size

    returns

    WatchQueryBuilder

    Since

    1.8

  7. def boundedStream(capacity: Int): Stream[F, ChangeStreamDocument[T]]
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException])
  9. def collation(collation: Collation): WatchQueryBuilder[F, T]

    Sets the collation options

    Sets the collation options

    collation

    the collation options to use

    returns

    WatchQueryBuilder

  10. val commands: List[WatchCommand[T]]
    Attributes
    protected
    Definition Classes
    WatchQueryBuilder → QueryBuilder
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def fullDocument(fullDocument: FullDocument): WatchQueryBuilder[F, T]

    Sets the fullDocument value.

    Sets the fullDocument value.

    fullDocument

    the fullDocument

    returns

    WatchQueryBuilder

  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. def maxAwaitTime(maxAwaitTime: Duration): WatchQueryBuilder[F, T]

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

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

    maxAwaitTime

    the max await time.

    returns

    WatchQueryBuilder

  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. val observable: ChangeStreamPublisher[T]
    Attributes
    protected
    Definition Classes
    WatchQueryBuilder → QueryBuilder
  20. def productElementNames: Iterator[String]
    Definition Classes
    Product
  21. def resumeAfter(resumeToken: BsonDocument): WatchQueryBuilder[F, T]

    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

    WatchQueryBuilder

  22. def startAfter(startAfter: BsonDocument): WatchQueryBuilder[F, T]

    Similar to resumeAfter, this option takes a resume token and starts a new change stream returning the first notification after the token.

    Similar to resumeAfter, this option takes a resume token and starts a new change stream returning the first notification after the token.

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

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

    startAfter

    the startAfter resumeToken

    returns

    WatchQueryBuilder

  23. def startAtOperationTime(startAtOperationTime: BsonTimestamp): WatchQueryBuilder[F, T]

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

    The change stream will only provide changes that occurred 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

    WatchQueryBuilder

    Since

    1.9

  24. def stream: Stream[F, ChangeStreamDocument[T]]
  25. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  27. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from QueryBuilder[ChangeStreamPublisher, T]

Inherited from AnyRef

Inherited from Any

Ungrouped