case class MapReduceObservable[TResult](wrapped: MapReduceIterable[TResult]) extends Observable[TResult] with Product with Serializable
Observable for map reduce.
- Alphabetic
- By Inheritance
- MapReduceObservable
- Serializable
- Serializable
- Product
- Equals
- Observable
- Observable
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new MapReduceObservable(wrapped: MapReduceIterable[TResult])
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
-
def
action(action: MapReduceAction): MapReduceObservable[TResult]
Specify the
MapReduceAction
to be used when writing to a collection.Specify the
MapReduceAction
to be used when writing to a collection.- action
an model.MapReduceAction to perform on the collection
- returns
this
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
bypassDocumentValidation(bypassDocumentValidation: Boolean): MapReduceObservable[TResult]
Sets the bypass document level validation flag.
Sets the bypass document level validation flag.
Note:: This only applies when an
$out
stage is specified.- bypassDocumentValidation
If true, allows the write to opt-out of document level validation.
- returns
this
- Since
1.1
- Note
Requires MongoDB 3.2 or greater
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
collation(collation: Collation): MapReduceObservable[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
collectionName(collectionName: String): MapReduceObservable[TResult]
Sets the collectionName for the output of the MapReduce
Sets the collectionName for the output of the MapReduce
The default action is replace the collection if it exists, to change this use action.
- collectionName
the name of the collection that you want the map-reduce operation to write its output.
- returns
this
-
def
databaseName(databaseName: String): MapReduceObservable[TResult]
Sets the name of the database to output into.
Sets the name of the database to output into.
- databaseName
the name of the database to output into.
- returns
this
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
filter(filter: Bson): MapReduceObservable[TResult]
Sets the query filter to apply to the query.
Sets the query filter to apply to the query.
- filter
the filter to apply to the query.
- returns
this
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
finalizeFunction(finalizeFunction: String): MapReduceObservable[TResult]
Sets the JavaScript function that follows the reduce method and modifies the output.
Sets the JavaScript function that follows the reduce method and modifies the output.
- finalizeFunction
the JavaScript function that follows the reduce method and modifies the output.
- returns
this
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
jsMode(jsMode: Boolean): MapReduceObservable[TResult]
Sets the flag that specifies whether to convert intermediate data into BSON format between the execution of the map and reduce functions.
Sets the flag that specifies whether to convert intermediate data into BSON format between the execution of the map and reduce functions. Defaults to false.
- jsMode
the flag that specifies whether to convert intermediate data into BSON format between the execution of the map and reduce functions
- returns
jsMode
-
def
limit(limit: Int): MapReduceObservable[TResult]
Sets the limit to apply.
Sets the limit to apply.
- limit
the limit, which may be null
- returns
this
-
def
maxTime(duration: Duration): MapReduceObservable[TResult]
Sets the maximum execution time on the server for this operation.
Sets the maximum execution time on the server for this operation.
- duration
the duration
- returns
this
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
nonAtomic(nonAtomic: Boolean): MapReduceObservable[TResult]
Sets if the post-processing step will prevent MongoDB from locking the database.
Sets if the post-processing step will prevent MongoDB from locking the database.
Valid only with the
MapReduceAction.MERGE
orMapReduceAction.REDUCE
actions.- nonAtomic
if the post-processing step will prevent MongoDB from locking the database.
- returns
this
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
def
scope(scope: Bson): MapReduceObservable[TResult]
Sets the global variables that are accessible in the map, reduce and finalize functions.
Sets the global variables that are accessible in the map, reduce and finalize functions.
- scope
the global variables that are accessible in the map, reduce and finalize functions.
- returns
this
-
def
sharded(sharded: Boolean): MapReduceObservable[TResult]
Sets if the output database is sharded
Sets if the output database is sharded
- sharded
if the output database is sharded
- returns
this
-
def
sort(sort: Bson): MapReduceObservable[TResult]
Sets the sort criteria to apply to the query.
Sets the sort criteria to apply to the query.
- 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 thisObservable
- Definition Classes
- MapReduceObservable → 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 thisObservable
- 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
-
def
toCollection(): Observable[Completed]
Aggregates documents to a collection according to the specified map-reduce function with the given options, which must specify a non-inline result.
Aggregates documents to a collection according to the specified map-reduce function with the given options, which must specify a non-inline result.
- returns
a Observable with a single element indicating when the operation has completed Aggregation
-
def
verbose(verbose: Boolean): MapReduceObservable[TResult]
Sets whether to include the timing information in the result information.
Sets whether to include the timing information in the result information.
- verbose
whether to include the timing information in the result information.
- returns
this
-
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( ... )
- val wrapped: MapReduceIterable[TResult]
This is the documentation for the MongoDB Scala driver.
Driver structure
The mongodb scala driver.
To get started you need a MongoClient instance, either from a connection string or via a org.mongodb.scala.MongoClientSettings.
Notable packages include: