case class AggregateObservable[TResult](wrapped: AggregateIterable[TResult]) extends Observable[TResult] with Product with Serializable
Observable for aggregate
- TResult
The type of the result.
- wrapped
the underlying java AggregateObservable
- Since
1.0
- Alphabetic
- By Inheritance
- AggregateObservable
- Serializable
- Serializable
- Product
- Equals
- Observable
- Observable
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
AggregateObservable(wrapped: AggregateIterable[TResult])
- wrapped
the underlying java AggregateObservable
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
allowDiskUse(allowDiskUse: Boolean): AggregateObservable[TResult]
Enables writing to temporary files.
Enables writing to temporary files. A null value indicates that it's unspecified.
- allowDiskUse
true if writing to temporary files is enabled
- returns
this
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
bypassDocumentValidation(bypassDocumentValidation: Boolean): AggregateObservable[TResult]
Sets the bypass document level validation flag.
Sets the bypass document level validation flag.
Note:: This only applies when an
$outstage 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
- @native() @throws( ... )
-
def
collation(collation: Collation): AggregateObservable[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
-
def
comment(comment: String): AggregateObservable[TResult]
Sets the comment to the aggregation.
Sets the comment to the aggregation. A null value means no comment is set.
- comment
the comment
- returns
this
- Since
2.2
- Note
Requires MongoDB 3.6 or greater
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hint(hint: Bson): AggregateObservable[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
- Note
Requires MongoDB 3.6 or greater
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
maxAwaitTime(duration: Duration): AggregateObservable[TResult]
Sets the maximum await execution time on the server for this operation.
Sets the maximum await execution time on the server for this operation.
- duration
the duration
- returns
this
- Since
2.2
- Note
Requires MongoDB 3.6 or greater
-
def
maxTime(duration: Duration): AggregateObservable[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
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
def
subscribe(observer: Observer[_ >: TResult]): Unit
Request
Observableto start streaming data.Request
Observableto start streaming data.This is a "factory method" and can be called multiple times, each time starting a new Subscription. Each
Subscriptionwill work for only a single Observer.If the
Observablerejects the subscription attempt or otherwise fails it will signal the error via Observer.onError.- observer
the
Observerthat will consume signals from thisObservable
- Definition Classes
- AggregateObservable → Observable
-
def
subscribe(observer: com.mongodb.async.client.Observer[_ >: TResult]): Unit
Handles the automatic boxing of a Java
Observableso it conforms to the interface.Handles the automatic boxing of a Java
Observableso it conforms to the interface.- observer
the
Observerthat 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 according to the specified aggregation pipeline, which must end with a
$outstage.Aggregates documents according to the specified aggregation pipeline, which must end with a
$outstage.- returns
a Observable with a single element indicating when the operation has completed
-
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
- @native() @throws( ... )
Deprecated Value Members
-
def
useCursor(useCursor: Boolean): AggregateObservable[TResult]
Sets whether the server should use a cursor to return results.
Sets whether the server should use a cursor to return results.
- useCursor
whether the server should use a cursor to return results
- returns
this
- Annotations
- @deprecated
- Deprecated
(Since version 2.2) No replacement for this method
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: