Packages

c

org.mongodb.scala

FindObservable

case class FindObservable[TResult](wrapped: FindIterable[TResult]) extends Observable[TResult] with Product with Serializable

Observable interface for Find.

TResult

The type of the result.

wrapped

the underlying java FindObservable

Since

1.0

Linear Supertypes
Serializable, Product, Equals, Observable[TResult], com.mongodb.async.client.Observable[TResult], AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FindObservable
  2. Serializable
  3. Product
  4. Equals
  5. Observable
  6. Observable
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new FindObservable(wrapped: FindIterable[TResult])

    wrapped

    the underlying java FindObservable

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def batchSize(batchSize: Int): FindObservable[TResult]

    Sets the number of documents to return per batch.

    Sets the number of documents to return per batch.

    batchSize

    the batch size

    returns

    this

    Since

    2.7

  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  7. def collation(collation: Collation): FindObservable[TResult]

    Sets the collation options

    Sets the collation options

    collation

    the collation options to use

    returns

    this

    Since

    1.2

    Note

    A null value represents the server default.

    ,

    Requires MongoDB 3.4 or greater

  8. def comment(comment: String): FindObservable[TResult]

    Sets the comment to the query.

    Sets the comment to the query. A null value means no comment is set.

    comment

    the comment

    returns

    this

    Since

    2.2

  9. def cursorType(cursorType: CursorType): FindObservable[TResult]

    Sets the cursor type.

    Sets the cursor type.

    cursorType

    the cursor type

    returns

    this

  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def filter(filter: Bson): FindObservable[TResult]

    Sets the query filter to apply to the query.

    Sets the query filter to apply to the query.

    Filter

    filter

    the filter, which may be null.

    returns

    this

  12. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  13. def first(): SingleObservable[TResult]

    Helper to return a Observable limited to just the first result the query.

    Helper to return a Observable limited to just the first result the query.

    **Note:** Sets limit in the background so only returns 1.

    returns

    a Observable which will return the first item

  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. def hint(hint: Bson): FindObservable[TResult]

    Sets the hint for which index to use.

    Sets the hint for which index to use. A null value means no hint is set.

    hint

    the hint

    returns

    this

    Since

    2.2

  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. def limit(limit: Int): FindObservable[TResult]

    Sets the limit to apply.

    Sets the limit to apply.

    Limit

    limit

    the limit, which may be null

    returns

    this

  18. def max(max: Bson): FindObservable[TResult]

    Sets the exclusive upper bound for a specific index.

    Sets the exclusive upper bound for a specific index. A null value means no max is set.

    max

    the max

    returns

    this

    Since

    2.2

  19. def maxAwaitTime(duration: Duration): FindObservable[TResult]

    The maximum amount of time for the server to wait on new documents to satisfy a tailable cursor query.

    The maximum amount of time for the server to wait on new documents to satisfy a tailable cursor query. This only applies to a TAILABLE_AWAIT cursor. When the cursor is not a TAILABLE_AWAIT cursor, this option is ignored.

    On servers >= 3.2, this option will be specified on the getMore command as "maxTimeMS". The default is no value: no "maxTimeMS" is sent to the server with the getMore command.

    On servers < 3.2, this option is ignored, and indicates that the driver should respect the server's default value

    A zero value will be ignored.

    Max Time

    duration

    the duration

    returns

    the maximum await execution time in the given time unit

    Since

    1.1

  20. def maxTime(duration: Duration): FindObservable[TResult]

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

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

    Max Time

    duration

    the duration

    returns

    this

  21. def min(min: Bson): FindObservable[TResult]

    Sets the minimum inclusive lower bound for a specific index.

    Sets the minimum inclusive lower bound for a specific index. A null value means no max is set.

    min

    the min

    returns

    this

    Since

    2.2

  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. def noCursorTimeout(noCursorTimeout: Boolean): FindObservable[TResult]

    The server normally times out idle cursors after an inactivity period (10 minutes) to prevent excess memory use.

    The server normally times out idle cursors after an inactivity period (10 minutes) to prevent excess memory use. Set this option to prevent that.

    noCursorTimeout

    true if cursor timeout is disabled

    returns

    this

  24. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  26. def oplogReplay(oplogReplay: Boolean): FindObservable[TResult]

    Users should not set this under normal circumstances.

    Users should not set this under normal circumstances.

    oplogReplay

    if oplog replay is enabled

    returns

    this

  27. def partial(partial: Boolean): FindObservable[TResult]

    Get partial results from a sharded cluster if one or more shards are unreachable (instead of throwing an error).

    Get partial results from a sharded cluster if one or more shards are unreachable (instead of throwing an error).

    partial

    if partial results for sharded clusters is enabled

    returns

    this

  28. def productElementNames: Iterator[String]
    Definition Classes
    Product
  29. def projection(projection: Bson): FindObservable[TResult]

    Sets a document describing the fields to return for all matching documents.

    Sets a document describing the fields to return for all matching documents.

    Projection

    projection

    the project document, which may be null.

    returns

    this

  30. def returnKey(returnKey: Boolean): FindObservable[TResult]

    Sets the returnKey.

    Sets the returnKey. If true the find operation will return only the index keys in the resulting documents.

    returnKey

    the returnKey

    returns

    this

    Since

    2.2

  31. def showRecordId(showRecordId: Boolean): FindObservable[TResult]

    Sets the showRecordId.

    Sets the showRecordId. Set to true to add a field $recordId to the returned documents.

    showRecordId

    the showRecordId

    returns

    this

    Since

    2.2

  32. def skip(skip: Int): FindObservable[TResult]

    Sets the number of documents to skip.

    Sets the number of documents to skip.

    Skip

    skip

    the number of documents to skip

    returns

    this

  33. def sort(sort: Bson): FindObservable[TResult]

    Sets the sort criteria to apply to the query.

    Sets the sort criteria to apply to the query.

    Sort

    sort

    the sort criteria, which may be null.

    returns

    this

  34. def subscribe(observer: Observer[_ >: TResult]): Unit

    Request Observable to start streaming data.

    Request Observable to start streaming data.

    This is a "factory method" and can be called multiple times, each time starting a new Subscription. Each Subscription will work for only a single Observer.

    If the Observable rejects the subscription attempt or otherwise fails it will signal the error via Observer.onError.

    observer

    the Observer that will consume signals from this Observable

    Definition Classes
    FindObservable → Observable
  35. def subscribe(observer: com.mongodb.async.client.Observer[_ >: TResult]): Unit

    Handles the automatic boxing of a Java Observable so it conforms to the interface.

    Handles the automatic boxing of a Java Observable so it conforms to the interface.

    observer

    the Observer that will consume signals from this Observable

    Definition Classes
    Observable → Observable
    Note

    Users should not have to implement this method but rather use the Scala Observable.

  36. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  37. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  38. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  39. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def maxScan(maxScan: Long): FindObservable[TResult]

    Sets the maximum number of documents or index keys to scan when executing the query.

    Sets the maximum number of documents or index keys to scan when executing the query.

    A zero value or less will be ignored, and indicates that the driver should respect the server's default value.

    maxScan

    the maxScan

    returns

    this

    Annotations
    @deprecated
    Deprecated

    (Since version 2.4) Deprecated as of MongoDB 4.0 release

    Since

    2.2

  2. def modifiers(modifiers: Bson): FindObservable[TResult]

    Sets the query modifiers to apply to this operation.

    Sets the query modifiers to apply to this operation.

    Query Modifiers

    modifiers

    the query modifiers to apply, which may be null.

    returns

    this

    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) use the individual setters instead

  3. def snapshot(snapshot: Boolean): FindObservable[TResult]

    Sets the snapshot.

    Sets the snapshot.

    If true it prevents the cursor from returning a document more than once because of an intervening write operation.

    snapshot

    the snapshot

    returns

    this

    Annotations
    @deprecated
    Deprecated

    (Since version 2.4) Deprecated in MongoDB 3.6 release and removed in MongoDB 4.0 release

    Since

    2.2

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Observable[TResult]

Inherited from com.mongodb.async.client.Observable[TResult]

Inherited from AnyRef

Inherited from Any

Ungrouped