AggregationFramework

Type Members

case class AddFieldToSet(field: String) extends AggregationFramework.GroupFunction with Product with Serializable

Definition Classes
GroupAggregation
case class AddFields(specifications: P.Document) extends PipelineOperator with Product with Serializable

Since MongoDB 3.
case class AddToSet(addToSetExpr: P.Value) extends AggregationFramework.GroupFunction with Product with Serializable
case class Aggregate(pipeline: Seq[PipelineOperator], explain: Boolean = false, allowDiskUse: Boolean, cursor: Option[Cursor], wireVersion: MongoWireVersion, bypassDocumentValidation: Boolean, readConcern: Option[ReadConcern]) extends CollectionCommand with CommandWithPack[pack.type] with CommandWithResult[AggregationResult] with Product with Serializable
case class AggregationResult(firstBatch: List[P.Document], cursor: Option[ResultCursor] = scala.None) extends Product with Serializable
case class Ascending(field: String) extends SortOrder with Product with Serializable

Ascending sort order
case class Avg(avgExpr: P.Value) extends AggregationFramework.GroupFunction with Product with Serializable

Definition Classes
GroupAggregation
case class AvgField(field: String) extends AggregationFramework.GroupFunction with Product with Serializable

Definition Classes
GroupAggregation
case class BucketAuto(groupBy: P.Value, buckets: Int, granularity: Option[String])(output: (String, AggregationFramework.GroupFunction)*) extends PipelineOperator with Product with Serializable

Since MongoDB 3.
case class Cursor(batchSize: Int) extends Product with Serializable
case class Descending(field: String) extends SortOrder with Product with Serializable

Descending sort order
case class Filter(input: P.Value, as: String, cond: P.Document) extends PipelineOperator with Product with Serializable

The $filter aggregation stage.
case class First(firstExpr: P.Value) extends AggregationFramework.GroupFunction with Product with Serializable

Definition Classes
GroupAggregation
case class FirstField(field: String) extends AggregationFramework.GroupFunction with Product with Serializable

Definition Classes
GroupAggregation
case class GeoNear(near: P.Value, spherical: Boolean = false, limit: Long = 100, minDistance: Option[Long] = scala.None, maxDistance: Option[Long] = scala.None, query: Option[P.Document] = scala.None, distanceMultiplier: Option[Double] = scala.None, uniqueDocs: Boolean = false, distanceField: Option[String] = scala.None, includeLocs: Option[String] = scala.None) extends PipelineOperator with Product with Serializable

Outputs documents in order of nearest to farthest from a specified point.
case class GraphLookup(from: String, startWith: P.Value, connectFromField: String, connectToField: String, as: String, maxDepth: Option[Int] = scala.None, depthField: Option[String] = scala.None, restrictSearchWithMatch: Option[P.Value] = scala.None) extends PipelineOperator with Product with Serializable

_Since MongoDB 3.
case class Group(identifiers: P.Value)(ops: (String, AggregationFramework.GroupFunction)*) extends PipelineOperator with Product with Serializable

Groups documents together to calculate aggregates on document collections.
case class GroupField(idField: String)(ops: (String, AggregationFramework.GroupFunction)*) extends PipelineOperator with Product with Serializable

Groups documents together to calculate aggregates on document collections.
sealed trait GroupFunction extends AnyRef

Represents one of the group/accumulator operators, for the $group aggregation.
case class GroupMulti(idFields: (String, String)*)(ops: (String, AggregationFramework.GroupFunction)*) extends PipelineOperator with Product with Serializable

Groups documents together to calculate aggregates on document collections.
trait ImplicitlyDocumentProducer extends AnyRef

Definition Classes
ImplicitCommandHelpers
case class IndexStatAccesses(ops: Long, since: Long) extends Product with Serializable
case class IndexStatsResult(name: String, key: P.Document, host: String, accesses: IndexStatAccesses) extends Product with Serializable
case class Last(lastExpr: P.Value) extends AggregationFramework.GroupFunction with Product with Serializable

Definition Classes
GroupAggregation
case class LastField(field: String) extends AggregationFramework.GroupFunction with Product with Serializable

Definition Classes
GroupAggregation
case class Limit(limit: Int) extends PipelineOperator with Product with Serializable

Limits the number of documents that pass through the stream.
case class Lookup(from: String, localField: String, foreignField: String, as: String) extends PipelineOperator with Product with Serializable

_Since MongoDB 3.
case class Match(predicate: P.Document) extends PipelineOperator with Product with Serializable

Filters out documents from the stream that do not match the predicate.
case class Max(maxExpr: P.Value) extends AggregationFramework.GroupFunction with Product with Serializable
case class MaxField(field: String) extends AggregationFramework.GroupFunction with Product with Serializable

Definition Classes
GroupAggregation
sealed trait MetadataKeyword extends AnyRef

Keyword of metadata.
case class MetadataSort(field: String, keyword: MetadataKeyword) extends SortOrder with Product with Serializable

Metadata sort order.
case class Min(minExpr: P.Value) extends AggregationFramework.GroupFunction with Product with Serializable
case class MinField(field: String) extends AggregationFramework.GroupFunction with Product with Serializable

Definition Classes
GroupAggregation
case class Out(collection: String) extends PipelineOperator with Product with Serializable

Takes the documents returned by the aggregation pipeline and writes them to a specified collection http://docs.
sealed trait PipelineOperator extends AnyRef

One of MongoDBs pipeline operators for aggregation.
case class Project(specifications: P.Document) extends PipelineOperator with Product with Serializable

Reshapes a document stream by renaming, adding, or removing fields.
case class Push(pushExpr: P.Value) extends AggregationFramework.GroupFunction with Product with Serializable
case class PushField(field: String) extends AggregationFramework.GroupFunction with Product with Serializable

Definition Classes
GroupAggregation
case class Redact(expression: P.Document) extends PipelineOperator with Product with Serializable

Restricts the contents of the documents based on information stored in the documents themselves.
case class Sample(size: Int) extends PipelineOperator with Product with Serializable

Randomly selects the specified number of documents from its input.
case class Skip(skip: Int) extends PipelineOperator with Product with Serializable

Skips over a number of documents before passing all further documents along the stream.
case class Sort(fields: SortOrder*) extends PipelineOperator with Product with Serializable

Sorts the stream based on the given fields.
sealed trait SortOrder extends AnyRef

Represents that a field should be sorted on, as well as whether it should be ascending or descending.
case class StdDevPop(expression: P.Value) extends AggregationFramework.GroupFunction with Product with Serializable

The $stdDevPop group accumulator (since MongoDB 3.
case class StdDevPopField(field: String) extends AggregationFramework.GroupFunction with Product with Serializable

The $stdDevPop for a single field (since MongoDB 3.
case class StdDevSamp(expression: P.Value) extends AggregationFramework.GroupFunction with Product with Serializable

The $stdDevSamp group accumulator (since MongoDB 3.
case class StdDevSampField(field: String) extends AggregationFramework.GroupFunction with Product with Serializable

The $stdDevSamp for a single field (since MongoDB 3.
case class Sum(sumExpr: P.Value) extends AggregationFramework.GroupFunction with Product with Serializable
case class SumField(field: String) extends AggregationFramework.GroupFunction with Product with Serializable

Definition Classes
GroupAggregation
class Unwind extends PipelineOperator with Product with Serializable with Serializable
case class UnwindField(field: String) extends Unwind with Product with Serializable

Turns a document with an array into multiple documents, one document for each element in the array.
case class SumValue(value: Int) extends AggregationFramework.GroupFunction with Product with Serializable

Definition Classes
GroupAggregation
Annotations
@deprecated
Deprecated
(Since version 0.12.0) Use SumAll

Abstract Value Members

abstract def booleanValue(b: Boolean): P.Value

Returns an boolean as a serialized value.
Returns an boolean as a serialized value.

Attributes
protected
abstract def doubleValue(d: Double): P.Value

Returns an double as a serialized value.
Returns an double as a serialized value.

Attributes
protected
abstract def elementProducer(name: String, value: P.Value): P.ElementProducer

Returns a producer of element for the given name and value.
Returns a producer of element for the given name and value.
name
the element name
value
the element value

Attributes
protected
abstract def intValue(i: Int): P.Value

Returns an integer as a serialized value.
Returns an integer as a serialized value.

Attributes
protected
abstract def longValue(l: Long): P.Value

Returns an long as a serialized value.
Returns an long as a serialized value.

Attributes
protected
abstract def makeArray(value: P.Value, values: Seq[P.Value]): P.Value

Returns a non empty array of values
Returns a non empty array of values

Attributes
protected
abstract def makeDocument(elements: Seq[P.ElementProducer]): P.Document

Returns a document from a sequence of element producers.
Returns a document from a sequence of element producers.

Attributes
protected
abstract val pack: P

Definition Classes
ImplicitCommandHelpers
abstract def stringValue(s: String): P.Value

Returns an string as a serialized value.
Returns an string as a serialized value.

Attributes
protected

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
AnyRef → Any
def +(other: String): String

Implicit information
This member is added by an implicit conversion from AggregationFramework[P] to StringAdd performed by method any2stringadd in scala.Predef.
Definition Classes
StringAdd
def ->[B](y: B): (AggregationFramework[P], B)

Implicit information
This member is added by an implicit conversion from AggregationFramework[P] to ArrowAssoc[AggregationFramework[P]] performed by method any2ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
final def ==(arg0: AnyRef): Boolean

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

Definition Classes
Any
object Filter extends Serializable

Filter companion
object GroupFunction

Factory to declare custom call to a group function.
object ImplicitlyDocumentProducer

Definition Classes
ImplicitCommandHelpers
object IndexStats extends PipelineOperator with Product with Serializable

Since MongoDB 3.
object PipelineOperator

Only for advanced user: Factory for stage not already provided in the API.
object SumAll extends AggregationFramework.GroupFunction with Product with Serializable

Sum operation of the form $sum: 1
object TextScore extends MetadataKeyword with Product with Serializable

References the score associated with the corresponding $text query for each matching document.
object Unwind extends Serializable
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def ensuring(cond: (AggregationFramework[P]) ⇒ Boolean, msg: ⇒ Any): AggregationFramework[P]

Implicit information
This member is added by an implicit conversion from AggregationFramework[P] to Ensuring[AggregationFramework[P]] performed by method any2Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (AggregationFramework[P]) ⇒ Boolean): AggregationFramework[P]

Implicit information
This member is added by an implicit conversion from AggregationFramework[P] to Ensuring[AggregationFramework[P]] performed by method any2Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: ⇒ Any): AggregationFramework[P]

Implicit information
This member is added by an implicit conversion from AggregationFramework[P] to Ensuring[AggregationFramework[P]] performed by method any2Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): AggregationFramework[P]

Implicit information
This member is added by an implicit conversion from AggregationFramework[P] to Ensuring[AggregationFramework[P]] performed by method any2Ensuring in scala.Predef.
Definition Classes
Ensuring
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def formatted(fmtstr: String): String

Implicit information
This member is added by an implicit conversion from AggregationFramework[P] to StringFormat performed by method any2stringfmt in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
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
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
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 →[B](y: B): (AggregationFramework[P], B)

Implicit information
This member is added by an implicit conversion from AggregationFramework[P] to ArrowAssoc[AggregationFramework[P]] performed by method any2ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc

Shadowed Implicit Value Members

val self: Any
Implicit information
This member is added by an implicit conversion from AggregationFramework[P] to StringAdd performed by method any2stringadd in scala.Predef.
Shadowing
This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
To access this member you can use a type ascription:
(aggregationFramework: StringAdd).self
Definition Classes
StringAdd
val self: Any
Implicit information
This member is added by an implicit conversion from AggregationFramework[P] to StringFormat performed by method any2stringfmt in scala.Predef.
Shadowing
This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
To access this member you can use a type ascription:
(aggregationFramework: StringFormat).self
Definition Classes
StringFormat

Deprecated Value Members

def x: AggregationFramework[P]
Implicit information
This member is added by an implicit conversion from AggregationFramework[P] to ArrowAssoc[AggregationFramework[P]] performed by method any2ArrowAssoc in scala.Predef.
Shadowing
This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
To access this member you can use a type ascription:
(aggregationFramework: ArrowAssoc[AggregationFramework[P]]).x
Definition Classes
ArrowAssoc
Annotations
@deprecated
Deprecated
(Since version 2.10.0) Use leftOfArrow instead
def x: AggregationFramework[P]
Implicit information
This member is added by an implicit conversion from AggregationFramework[P] to Ensuring[AggregationFramework[P]] performed by method any2Ensuring in scala.Predef.
Shadowing
This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
To access this member you can use a type ascription:
(aggregationFramework: Ensuring[AggregationFramework[P]]).x
Definition Classes
Ensuring
Annotations
@deprecated
Deprecated
(Since version 2.10.0) Use resultOfEnsuring instead

trait AggregationFramework[P <: SerializationPack] extends ImplicitCommandHelpers[P] with GroupAggregation[P]

Type Members

case class AddFieldToSet(field: String) extends AggregationFramework.GroupFunction with Product with Serializable

case class AddFields(specifications: P.Document) extends PipelineOperator with Product with Serializable

case class AddToSet(addToSetExpr: P.Value) extends AggregationFramework.GroupFunction with Product with Serializable

case class AggregationResult(firstBatch: List[P.Document], cursor: Option[ResultCursor] = scala.None) extends Product with Serializable

case class Ascending(field: String) extends SortOrder with Product with Serializable

case class Avg(avgExpr: P.Value) extends AggregationFramework.GroupFunction with Product with Serializable

case class AvgField(field: String) extends AggregationFramework.GroupFunction with Product with Serializable

case class BucketAuto(groupBy: P.Value, buckets: Int, granularity: Option[String])(output: (String, AggregationFramework.GroupFunction)*) extends PipelineOperator with Product with Serializable

case class Cursor(batchSize: Int) extends Product with Serializable

case class Descending(field: String) extends SortOrder with Product with Serializable

case class Filter(input: P.Value, as: String, cond: P.Document) extends PipelineOperator with Product with Serializable

case class First(firstExpr: P.Value) extends AggregationFramework.GroupFunction with Product with Serializable

case class FirstField(field: String) extends AggregationFramework.GroupFunction with Product with Serializable

case class Group(identifiers: P.Value)(ops: (String, AggregationFramework.GroupFunction)*) extends PipelineOperator with Product with Serializable

case class GroupField(idField: String)(ops: (String, AggregationFramework.GroupFunction)*) extends PipelineOperator with Product with Serializable

sealed trait GroupFunction extends AnyRef

case class GroupMulti(idFields: (String, String)*)(ops: (String, AggregationFramework.GroupFunction)*) extends PipelineOperator with Product with Serializable

trait ImplicitlyDocumentProducer extends AnyRef

case class IndexStatAccesses(ops: Long, since: Long) extends Product with Serializable

case class IndexStatsResult(name: String, key: P.Document, host: String, accesses: IndexStatAccesses) extends Product with Serializable

case class Last(lastExpr: P.Value) extends AggregationFramework.GroupFunction with Product with Serializable

case class LastField(field: String) extends AggregationFramework.GroupFunction with Product with Serializable

case class Limit(limit: Int) extends PipelineOperator with Product with Serializable

case class Lookup(from: String, localField: String, foreignField: String, as: String) extends PipelineOperator with Product with Serializable

case class Match(predicate: P.Document) extends PipelineOperator with Product with Serializable

case class Max(maxExpr: P.Value) extends AggregationFramework.GroupFunction with Product with Serializable

case class MaxField(field: String) extends AggregationFramework.GroupFunction with Product with Serializable

sealed trait MetadataKeyword extends AnyRef

case class MetadataSort(field: String, keyword: MetadataKeyword) extends SortOrder with Product with Serializable

case class Min(minExpr: P.Value) extends AggregationFramework.GroupFunction with Product with Serializable

case class MinField(field: String) extends AggregationFramework.GroupFunction with Product with Serializable

case class Out(collection: String) extends PipelineOperator with Product with Serializable

sealed trait PipelineOperator extends AnyRef

case class Project(specifications: P.Document) extends PipelineOperator with Product with Serializable

case class Push(pushExpr: P.Value) extends AggregationFramework.GroupFunction with Product with Serializable

case class PushField(field: String) extends AggregationFramework.GroupFunction with Product with Serializable

case class Redact(expression: P.Document) extends PipelineOperator with Product with Serializable

case class Sample(size: Int) extends PipelineOperator with Product with Serializable

case class Skip(skip: Int) extends PipelineOperator with Product with Serializable

case class Sort(fields: SortOrder*) extends PipelineOperator with Product with Serializable

sealed trait SortOrder extends AnyRef

case class StdDevPop(expression: P.Value) extends AggregationFramework.GroupFunction with Product with Serializable

case class StdDevPopField(field: String) extends AggregationFramework.GroupFunction with Product with Serializable

case class StdDevSamp(expression: P.Value) extends AggregationFramework.GroupFunction with Product with Serializable

case class StdDevSampField(field: String) extends AggregationFramework.GroupFunction with Product with Serializable

case class Sum(sumExpr: P.Value) extends AggregationFramework.GroupFunction with Product with Serializable

case class SumField(field: String) extends AggregationFramework.GroupFunction with Product with Serializable

class Unwind extends PipelineOperator with Product with Serializable with Serializable

case class UnwindField(field: String) extends Unwind with Product with Serializable

case class SumValue(value: Int) extends AggregationFramework.GroupFunction with Product with Serializable

Abstract Value Members

abstract def booleanValue(b: Boolean): P.Value

abstract def doubleValue(d: Double): P.Value

abstract def elementProducer(name: String, value: P.Value): P.ElementProducer

abstract def intValue(i: Int): P.Value

abstract def longValue(l: Long): P.Value

abstract def makeArray(value: P.Value, values: Seq[P.Value]): P.Value

abstract def makeDocument(elements: Seq[P.ElementProducer]): P.Document

abstract val pack: P

abstract def stringValue(s: String): P.Value

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(other: String): String

def ->[B](y: B): (AggregationFramework[P], B)

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

object Filter extends Serializable

object GroupFunction

object ImplicitlyDocumentProducer

object IndexStats extends PipelineOperator with Product with Serializable

object PipelineOperator

object SumAll extends AggregationFramework.GroupFunction with Product with Serializable

object TextScore extends MetadataKeyword with Product with Serializable

object Unwind extends Serializable

final def asInstanceOf[T0]: T0

case class GroupMulti(idFields: (String, String))(ops: (String, AggregationFramework.GroupFunction)) extends PipelineOperator with Product with Serializable