class AggregationOptions extends Object
Aggregation Options
- Annotations
- @RawJSType() @ScalaJSDefined()
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- AggregationOptions
- Object
- Any
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- All
Instance Constructors
-
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)
- 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
-
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
- var allowDiskUse: UndefOr[Boolean]
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
- var bypassDocumentValidation: UndefOr[Boolean]
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
- var cursor: UndefOr[AggregationCursorOptions]
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- var explain: UndefOr[Boolean]
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
def
hasOwnProperty(v: String): Boolean
- Definition Classes
- Object
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
isPrototypeOf(v: Object): Boolean
- Definition Classes
- Object
- var maxTimeMS: UndefOr[Integer]
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
def
propertyIsEnumerable(v: String): Boolean
- Definition Classes
- Object
- var readPreference: UndefOr[ReadPreference]
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toLocaleString(): String
- Definition Classes
- Object
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
def
valueOf(): Any
- Definition Classes
- Object
-
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( ... )