FindObservable

Instance Constructors

new FindObservable(wrapped: FindIterable[TResult])

wrapped
the underlying java FindObservable

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
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
Requires MongoDB 3.4 or greater
,
A null value represents the server default.
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
def cursorType(cursorType: CursorType): FindObservable[TResult]

Sets the cursor type.
Sets the cursor type.
cursorType
the cursor type
returns
this
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
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
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
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
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
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
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
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
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
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
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
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
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
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
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
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
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
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
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
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
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
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
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
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.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Deprecated Value Members

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

Related Doc: package scala

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

Instance Constructors

new FindObservable(wrapped: FindIterable[TResult])

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def collation(collation: Collation): FindObservable[TResult]

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

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

final def eq(arg0: AnyRef): Boolean

def filter(filter: Bson): FindObservable[TResult]

def finalize(): Unit

def first(): SingleObservable[TResult]

final def getClass(): Class[_]

def hint(hint: Bson): FindObservable[TResult]

final def isInstanceOf[T0]: Boolean

def limit(limit: Int): FindObservable[TResult]

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

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

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

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

final def ne(arg0: AnyRef): Boolean

def noCursorTimeout(noCursorTimeout: Boolean): FindObservable[TResult]

final def notify(): Unit

final def notifyAll(): Unit

def oplogReplay(oplogReplay: Boolean): FindObservable[TResult]

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

def projection(projection: Bson): FindObservable[TResult]

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

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

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

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

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

def subscribe(observer: com.mongodb.async.client.Observer[_ >: TResult]): Unit

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

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Deprecated Value Members

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

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

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

Inherited from Serializable

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