AggregationConfig

Instance Constructors

new AggregationConfig(collationString: Option[String] = None, hintString: Option[String] = None, pipelineString: Option[String] = None, allowDiskUse: Boolean = ...)

collationString
the optional collation config
hintString
the optional hint document in extended json format
pipelineString
the optional aggregation pipeline, either a list of documents in json syntax or a single document in json syntax
allowDiskUse
enables writing to temporary files

Type Members

type Self = AggregationConfig

Defines Self as a type that can be used to return a copy of the object i.e.
Defines Self as a type that can be used to return a copy of the object i.e. a different instance of the same type

Definition Classes
AggregationConfig → MongoClassConfig

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
val allowDiskUse: Boolean

enables writing to temporary files
final def asInstanceOf[T0]: T0

Definition Classes
Any
def asJavaOptions: Map[String, String]

Creates a map of options representing the configuration
Creates a map of options representing the configuration
returns
the map representing the configuration values

Definition Classes
AggregationConfig → MongoClassConfig
def asOptions: Map[String, String]

Creates a map of options representing this config.
Creates a map of options representing this config.
returns
the map representing the config

Definition Classes
AggregationConfig → MongoClassConfig
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
lazy val collation: Option[Collation]

returns
the collation option
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
lazy val hint: Option[BsonDocument]

The optional hint document
The optional hint document
returns
the bson hint document option
def isDefined: Boolean

returns
true if custom aggregation options have been defined.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
lazy val pipeline: Option[List[BsonDocument]]

returns
the pipeline option
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
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( ... )
def withOption(key: String, value: String): AggregationConfig

Creates a new config with the options applied
Creates a new config with the options applied
key
the configuration key
value
the configuration value
returns
an updated config

Definition Classes
AggregationConfig → MongoClassConfig
def withOptions(options: Map[String, String]): AggregationConfig

Creates a new config with the options applied
Creates a new config with the options applied
options
a map of options to be applied to the config
returns
an updated config

Definition Classes
AggregationConfig → MongoClassConfig
def withOptions(options: Map[String, String]): AggregationConfig

Creates a new config with the options applied
Creates a new config with the options applied
options
a map of options to be applied to the config
returns
an updated config

Definition Classes
AggregationConfig → MongoClassConfig

Related Docs: object AggregationConfig | package config

case class AggregationConfig(collationString: Option[String] = None, hintString: Option[String] = None, pipelineString: Option[String] = None, allowDiskUse: Boolean = ...) extends MongoClassConfig with Product with Serializable

Instance Constructors

new AggregationConfig(collationString: Option[String] = None, hintString: Option[String] = None, pipelineString: Option[String] = None, allowDiskUse: Boolean = ...)

Type Members

type Self = AggregationConfig

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val allowDiskUse: Boolean

final def asInstanceOf[T0]: T0

def asJavaOptions: Map[String, String]

def asOptions: Map[String, String]

def clone(): AnyRef

lazy val collation: Option[Collation]

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

lazy val hint: Option[BsonDocument]

def isDefined: Boolean

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

lazy val pipeline: Option[List[BsonDocument]]

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

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def withOption(key: String, value: String): AggregationConfig

def withOptions(options: Map[String, String]): AggregationConfig

def withOptions(options: Map[String, String]): AggregationConfig

Inherited from Product

Inherited from Equals

Inherited from MongoClassConfig

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped