Packages

c

org.mongodb.scala

AggregateObservable

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

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

Instance Constructors

  1. new AggregateObservable(wrapped: AggregateIterable[TResult])

    wrapped

    the underlying java AggregateObservable

Value Members

  1. def allowDiskUse(allowDiskUse: Boolean): AggregateObservable[TResult]

    Enables writing to temporary files.

    Enables writing to temporary files. A null value indicates that it's unspecified.

    Aggregation

    allowDiskUse

    true if writing to temporary files is enabled

    returns

    this

  2. 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 $out stage is specified.

    Aggregation

    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

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

    Requires MongoDB 3.4 or greater

    ,

    A null value represents the server default.

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

    Max Time

    duration

    the duration

    returns

    this

  5. 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
    AggregateObservable → Observable
  6. 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.

  7. def toCollection(): Observable[Completed]

    Aggregates documents according to the specified aggregation pipeline, which must end with a $out stage.

    Aggregates documents according to the specified aggregation pipeline, which must end with a $out stage.

    Aggregation

    returns

    a Observable with a single element indicating when the operation has completed

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

    Aggregation

    useCursor

    whether the server should use a cursor to return results

    returns

    this