Class

io.scalajs.npm.mongodb

AggregationOptions

Related Doc: package mongodb

Permalink

class AggregationOptions extends Object

Aggregation Options

Annotations
@RawJSType() @ScalaJSDefined()
Linear Supertypes
Object, Any, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AggregationOptions
  2. Object
  3. Any
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new AggregationOptions(readPreference: UndefOr[ReadPreference] = js.undefined, cursor: UndefOr[AggregationCursorOptions] = js.undefined, explain: UndefOr[Boolean] = js.undefined, allowDiskUse: UndefOr[Boolean] = js.undefined, maxTimeMS: UndefOr[Integer] = js.undefined, bypassDocumentValidation: UndefOr[Boolean] = js.undefined)

    Permalink

    readPreference

    The preferred read preference

    cursor

    Return the query as cursor, on 2.6 > it returns as a real cursor on pre 2.6 it returns as an emulated cursor.

    explain

    Explain returns the aggregation execution plan (requires mongodb 2.6 >).

    allowDiskUse

    allowDiskUse lets the server know if it can use disk to store temporary results for the aggregation (requires mongodb 2.6 >).

    maxTimeMS

    maxTimeMS specifies a cumulative time limit in milliseconds for processing operations on the cursor. MongoDB interrupts the operation at the earliest following interrupt point.

    bypassDocumentValidation

    Allow driver to bypass schema validation in MongoDB 3.2 or higher.

Value Members

  1. final def !=(arg0: Any): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. var allowDiskUse: UndefOr[Boolean]

    Permalink

    allowDiskUse lets the server know if it can use disk to store temporary results for the aggregation (requires mongodb 2.6 >).

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. var bypassDocumentValidation: UndefOr[Boolean]

    Permalink

    Allow driver to bypass schema validation in MongoDB 3.2 or higher.

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. var cursor: UndefOr[AggregationCursorOptions]

    Permalink

    Return the query as cursor, on 2.6 > it returns as a real cursor on pre 2.6 it returns as an emulated cursor.

  9. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  11. var explain: UndefOr[Boolean]

    Permalink

    Explain returns the aggregation execution plan (requires mongodb 2.6 >).

  12. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  14. def hasOwnProperty(v: String): Boolean

    Permalink
    Definition Classes
    Object
  15. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  16. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  17. def isPrototypeOf(v: Object): Boolean

    Permalink
    Definition Classes
    Object
  18. var maxTimeMS: UndefOr[Integer]

    Permalink

    maxTimeMS specifies a cumulative time limit in milliseconds for processing operations on the cursor.

    maxTimeMS specifies a cumulative time limit in milliseconds for processing operations on the cursor. MongoDB interrupts the operation at the earliest following interrupt point.

  19. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  20. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  21. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  22. def propertyIsEnumerable(v: String): Boolean

    Permalink
    Definition Classes
    Object
  23. var readPreference: UndefOr[ReadPreference]

    Permalink

    The preferred read preference

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

    Permalink
    Definition Classes
    AnyRef
  25. def toLocaleString(): String

    Permalink
    Definition Classes
    Object
  26. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  27. def valueOf(): Any

    Permalink
    Definition Classes
    Object
  28. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped