Workflow

Type Members

final case class $FlatMap[A](src: A, fn: AnonFunDecl, scope: Scope) extends MapReduceF[A] with Product with Serializable

Takes a function of two parameters.
Takes a function of two parameters. The first is the current key (which defaults to this._id, but may have been overridden by previous [Flat]$Maps) and the second is the document itself. The function must return an array of 2-element arrays, each containing a new key and a new value.
final case class $FoldLeft[A](head: A, tail: NonEmptyList[A]) extends WorkflowF[A] with Product with Serializable

Performs a sequence of operations, sequentially, merging their results.
final case class $GeoNear[A](src: A, near: (Double, Double), distanceField: BsonField, limit: Option[Int], maxDistance: Option[Double], query: Option[Selector], spherical: Option[Boolean], distanceMultiplier: Option[Double], includeLocs: Option[BsonField], uniqueDocs: Option[Boolean]) extends PipelineF[A] with Product with Serializable
final case class $Group[A](src: A, grouped: Grouped, by: Shape) extends PipelineF[A] with Product with Serializable
final case class $Limit[A](src: A, count: Long) extends ShapePreservingF[A] with Product with Serializable
final case class $Map[A](src: A, fn: AnonFunDecl, scope: Scope) extends MapReduceF[A] with Product with Serializable

Takes a function of two parameters.
Takes a function of two parameters. The first is the current key (which defaults to this._id, but may have been overridden by previous [Flat]$Maps) and the second is the document itself. The function must return a 2-element array containing the new key and new value.
final case class $Match[A](src: A, selector: Selector) extends ShapePreservingF[A] with Product with Serializable
final case class $Out[A](src: A, collection: Collection) extends ShapePreservingF[A] with Product with Serializable

TODO: If an $Out has anything after it, we need to either do
TODO: If an $Out has anything after it, we need to either do
```
$seq($out(src, dst), after($read(dst), ...))
```
or
```
$Fork(src, List($out(_, dst), after(_, ...)))
```
The latter seems preferable, but currently the forking semantics are not clear.
final case class $Project[A](src: A, shape: Reshape, idExclusion: IdHandling) extends PipelineF[A] with Product with Serializable
final case class $Pure(value: Bson) extends SourceOp with Product with Serializable
final case class $Read(coll: Collection) extends SourceOp with Product with Serializable
final case class $Redact[A](src: A, value: Expression) extends PipelineF[A] with Product with Serializable
final case class $Reduce[A](src: A, fn: AnonFunDecl, scope: Scope) extends MapReduceF[A] with Product with Serializable

Takes a function of two parameters – a key and an array of values.
Takes a function of two parameters – a key and an array of values. The function must return a single value.
final case class $SimpleMap[A](src: A, exprs: NonEmptyList[CardinalExpr[JsFn]], scope: Scope) extends MapReduceF[A] with Product with Serializable
final case class $Skip[A](src: A, count: Long) extends ShapePreservingF[A] with Product with Serializable
final case class $Sort[A](src: A, value: NonEmptyList[(BsonField, SortDir)]) extends ShapePreservingF[A] with Product with Serializable
final case class $Unwind[A](src: A, field: DocVar) extends PipelineF[A] with Product with Serializable
sealed trait CardinalExpr[A] extends AnyRef
final case class Crystallized(op: Workflow) extends Product with Serializable

A type for a Workflow which has had crystallize applied to it.
final case class FlatExpr[A](fn: A) extends CardinalExpr[A] with Product with Serializable
final case class MapExpr[A](fn: A) extends CardinalExpr[A] with Product with Serializable
sealed trait MapReduceF[A] extends SingleSourceF[A]
sealed abstract class PipelineF[A] extends SingleSourceF[A]

This should be renamed once the other PipelineOp goes away, but it is the subset of operations that can ever be pipelined.
type PipelineOp = PipelineF[Unit]
sealed abstract class ShapePreservingF[A] extends PipelineF[A]
sealed trait SingleSourceF[A] extends WorkflowF[A]

Operations with a single source op.
sealed trait SourceOp extends WorkflowF[Nothing]

Operations without an input.
type Workflow = Fix[WorkflowF]
type WorkflowOp = (Workflow) ⇒ Workflow

Value Members

final def !=(arg0: Any): Boolean

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

Definition Classes
AnyRef → Any
object $FlatMap extends Serializable
object $FoldLeft extends Serializable
object $GeoNear extends Serializable
object $Group extends Serializable
object $Limit extends Serializable
object $Map extends Serializable
object $Match extends Serializable
object $Out extends Serializable
object $Project extends Serializable
object $Redact extends Serializable
object $Reduce extends Serializable
object $SimpleMap extends Serializable
object $Skip extends Serializable
object $Sort extends Serializable
object $Unwind extends Serializable
val $flatMap: (AnonFunDecl, Scope) ⇒ (Workflow) ⇒ Workflow
def $foldLeft(first: Workflow, second: Workflow, rest: Workflow*): Workflow
val $geoNear: ((Double, Double), BsonField, Option[Int], Option[Double], Option[Selector], Option[Boolean], Option[Double], Option[BsonField], Option[Boolean]) ⇒ (Workflow) ⇒ Workflow
val $group: (Grouped, Shape) ⇒ (Workflow) ⇒ Workflow
val $limit: (Long) ⇒ (Workflow) ⇒ Workflow
val $map: (AnonFunDecl, Scope) ⇒ (Workflow) ⇒ Workflow
val $match: (Selector) ⇒ (Workflow) ⇒ Workflow
val $out: (Collection) ⇒ (Workflow) ⇒ Workflow
val $project: (Reshape, IdHandling) ⇒ (Workflow) ⇒ Workflow
def $pure(value: Bson): Fix[WorkflowF]
def $read(coll: Collection): Fix[WorkflowF]
val $redact: (Expression) ⇒ (Workflow) ⇒ Workflow
val $reduce: (AnonFunDecl, Scope) ⇒ (Workflow) ⇒ Workflow
val $simpleMap: (NonEmptyList[CardinalExpr[JsFn]], Scope) ⇒ (Workflow) ⇒ Workflow
val $skip: (Long) ⇒ (Workflow) ⇒ Workflow
val $sort: (NonEmptyList[(BsonField, SortDir)]) ⇒ (Workflow) ⇒ Workflow
val $unwind: (DocVar) ⇒ (Workflow) ⇒ Workflow
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
implicit val CardinalExprComonad: Comonad[CardinalExpr]
implicit val CrystallizedRenderTree: RenderTree[Crystallized]
val ExprLabel: String
val ExprName: Name
val ExprVar: DocVar
val IdLabel: String
val IdName: Name
val IdVar: DocVar
implicit val PipelineFTraverse: Traverse[PipelineF]
implicit val TraverseCardinalExpr: Traverse[CardinalExpr]
implicit val WorkflowFRenderTree: RenderTree[WorkflowF[Unit]]
implicit val WorkflowFTraverse: Traverse[WorkflowF]
implicit val WorkflowRenderTree: RenderTree[Workflow]
final def asInstanceOf[T0]: T0

Definition Classes
Any

def chain(src: Workflow, op1: WorkflowOp, ops: WorkflowOp*): Workflow

Flattens the sequence of operations like so:

chain(
  $read(Path.fileAbs("foo")),
  $match(Selector.Where(Js.Bool(true))),
  $limit(7))

val read = $read(Path.fileAbs("foo"))
val match = $match(Selector.Where(Js.Bool(true))(read)
$limit(7)(match)

def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val coalesce: (WorkflowF[Workflow]) ⇒ WorkflowF[Workflow]
val coalesceƒ: (WorkflowF[Workflow]) ⇒ Option[WorkflowF[Workflow]]
val collectShapes: (WorkflowF[(Workflow, (List[Reshape], Workflow))]) ⇒ (List[Reshape], Workflow)
def crystallize(op: Workflow): Crystallized

Performs some irreversible conversions, meant to be used once, after the entire workflow has been generated.
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] )
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
def pipeline[A <: PipelineF[Workflow]](op: A): Option[(DocVar, WorkflowTask, List[PipelineOp])]
def prefixBase(base: DocVar): PartialFunction[DocVar, DocVar]
final def refs[A <: WorkflowF[_]](op: A): List[DocVar]
def rewrite[A <: WorkflowF[_]](op: A, base: DocVar): (A, DocVar)
def rewriteRefs[A <: WorkflowF[_]](op: A, applyVar0: PartialFunction[DocVar, DocVar]): A
def simpleShape(op: Workflow): Option[List[Name]]
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def task(fop: Crystallized): WorkflowTask
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( ... )

Related Doc: package mongodb

object Workflow

Type Members

final case class $FlatMap[A](src: A, fn: AnonFunDecl, scope: Scope) extends MapReduceF[A] with Product with Serializable

final case class $FoldLeft[A](head: A, tail: NonEmptyList[A]) extends WorkflowF[A] with Product with Serializable

final case class $Group[A](src: A, grouped: Grouped, by: Shape) extends PipelineF[A] with Product with Serializable

final case class $Limit[A](src: A, count: Long) extends ShapePreservingF[A] with Product with Serializable

final case class $Map[A](src: A, fn: AnonFunDecl, scope: Scope) extends MapReduceF[A] with Product with Serializable

final case class $Match[A](src: A, selector: Selector) extends ShapePreservingF[A] with Product with Serializable

final case class $Out[A](src: A, collection: Collection) extends ShapePreservingF[A] with Product with Serializable

final case class $Project[A](src: A, shape: Reshape, idExclusion: IdHandling) extends PipelineF[A] with Product with Serializable

final case class $Pure(value: Bson) extends SourceOp with Product with Serializable

final case class $Read(coll: Collection) extends SourceOp with Product with Serializable

final case class $Redact[A](src: A, value: Expression) extends PipelineF[A] with Product with Serializable

final case class $Reduce[A](src: A, fn: AnonFunDecl, scope: Scope) extends MapReduceF[A] with Product with Serializable

final case class $SimpleMap[A](src: A, exprs: NonEmptyList[CardinalExpr[JsFn]], scope: Scope) extends MapReduceF[A] with Product with Serializable

final case class $Skip[A](src: A, count: Long) extends ShapePreservingF[A] with Product with Serializable

final case class $Sort[A](src: A, value: NonEmptyList[(BsonField, SortDir)]) extends ShapePreservingF[A] with Product with Serializable

final case class $Unwind[A](src: A, field: DocVar) extends PipelineF[A] with Product with Serializable

sealed trait CardinalExpr[A] extends AnyRef

final case class Crystallized(op: Workflow) extends Product with Serializable

final case class FlatExpr[A](fn: A) extends CardinalExpr[A] with Product with Serializable

final case class MapExpr[A](fn: A) extends CardinalExpr[A] with Product with Serializable

sealed trait MapReduceF[A] extends SingleSourceF[A]

sealed abstract class PipelineF[A] extends SingleSourceF[A]

type PipelineOp = PipelineF[Unit]

sealed abstract class ShapePreservingF[A] extends PipelineF[A]

sealed trait SingleSourceF[A] extends WorkflowF[A]

sealed trait SourceOp extends WorkflowF[Nothing]

type Workflow = Fix[WorkflowF]

type WorkflowOp = (Workflow) ⇒ Workflow

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

object $FlatMap extends Serializable

object $FoldLeft extends Serializable

object $GeoNear extends Serializable

object $Group extends Serializable

object $Limit extends Serializable

object $Map extends Serializable

object $Match extends Serializable

object $Out extends Serializable

object $Project extends Serializable

object $Redact extends Serializable

object $Reduce extends Serializable

object $SimpleMap extends Serializable

object $Skip extends Serializable

object $Sort extends Serializable

object $Unwind extends Serializable

val $flatMap: (AnonFunDecl, Scope) ⇒ (Workflow) ⇒ Workflow

def $foldLeft(first: Workflow, second: Workflow, rest: Workflow*): Workflow

val $geoNear: ((Double, Double), BsonField, Option[Int], Option[Double], Option[Selector], Option[Boolean], Option[Double], Option[BsonField], Option[Boolean]) ⇒ (Workflow) ⇒ Workflow

val $group: (Grouped, Shape) ⇒ (Workflow) ⇒ Workflow

val $limit: (Long) ⇒ (Workflow) ⇒ Workflow

val $map: (AnonFunDecl, Scope) ⇒ (Workflow) ⇒ Workflow

val $match: (Selector) ⇒ (Workflow) ⇒ Workflow

val $out: (Collection) ⇒ (Workflow) ⇒ Workflow

val $project: (Reshape, IdHandling) ⇒ (Workflow) ⇒ Workflow

def $pure(value: Bson): Fix[WorkflowF]

def $read(coll: Collection): Fix[WorkflowF]

val $redact: (Expression) ⇒ (Workflow) ⇒ Workflow

val $reduce: (AnonFunDecl, Scope) ⇒ (Workflow) ⇒ Workflow

val $simpleMap: (NonEmptyList[CardinalExpr[JsFn]], Scope) ⇒ (Workflow) ⇒ Workflow

val $skip: (Long) ⇒ (Workflow) ⇒ Workflow

val $sort: (NonEmptyList[(BsonField, SortDir)]) ⇒ (Workflow) ⇒ Workflow

val $unwind: (DocVar) ⇒ (Workflow) ⇒ Workflow

final def ==(arg0: Any): Boolean

implicit val CardinalExprComonad: Comonad[CardinalExpr]

implicit val CrystallizedRenderTree: RenderTree[Crystallized]

val ExprLabel: String

val ExprName: Name

val ExprVar: DocVar

val IdLabel: String

val IdName: Name

val IdVar: DocVar

implicit val PipelineFTraverse: Traverse[PipelineF]

implicit val TraverseCardinalExpr: Traverse[CardinalExpr]

implicit val WorkflowFRenderTree: RenderTree[WorkflowF[Unit]]

implicit val WorkflowFTraverse: Traverse[WorkflowF]