Type Members

1.  sealed abstract class Binary[T[_[_]], A] extends MapFuncCore[T, A]
2.  sealed abstract class BinaryDerived[T[_[_]], A] extends MapFuncDerived[T, A]
3.  trait Branches[T[_[_]], IN[_]] extends AnyRef
4.  final case class BucketIndex[T[_[_]], A](src: A, value: FreeMap[T], index: FreeMap[T]) extends ProjectBucket[T, A] with Product with Serializable
5.  final case class BucketKey[T[_[_]], A](src: A, value: FreeMap[T], name: FreeMap[T]) extends ProjectBucket[T, A] with Product with Serializable
6.  type CoEnvMap[T[_[_]], A] = CoEnv[Hole, [β$75$]Coproduct[[β$62$]MapFuncCore[T, β$62$], [β$63$]MapFuncDerived[T, β$63$], β$75$], A]
7.  type CoEnvMapA[T[_[_]], A, B] = CoEnv[A, [β$75$]Coproduct[[β$62$]MapFuncCore[T, β$62$], [β$63$]MapFuncDerived[T, β$63$], β$75$], B]
8.  type CoEnvQS[T[_[_]], A] = CoEnv[Hole, [β$74$]Coproduct[[β$0$]QScriptCore[T, β$0$], [β$1$]Coproduct[[β$2$]ProjectBucket[T, β$2$], [β$3$]Coproduct[[β$4$]ThetaJoin[T, β$4$], [β$5$]Coproduct[[β$6$]EquiJoin[T, β$6$], [β$7$]Coproduct[[β$8$]Const[ShiftedRead[Path[Abs, Dir, Sandboxed]], β$8$], [β$9$]Coproduct[[β$10$]Const[ShiftedRead[Path[Abs, File, Sandboxed]], β$10$], [β$11$]Coproduct[[β$12$]Const[Read[Path[Abs, Dir, Sandboxed]], β$12$], [β$13$]Coproduct[[β$14$]Const[Read[Path[Abs, File, Sandboxed]], β$14$], [β$15$]Const[DeadEnd, β$15$], β$13$], β$11$], β$9$], β$7$], β$5$], β$3$], β$1$], β$74$], A]
9.  sealed abstract class DeadEnd extends AnyRef
10.  trait DiscoverPath[IN[_]] extends AnyRef

    This extracts statically-known paths from QScript queries to make it easier for connectors to map queries to their own filesystems.

11.  abstract class DiscoverPathInstances extends AnyRef
12.  final case class EquiJoin[T[_[_]], A](src: A, lBranch: FreeQS[T], rBranch: FreeQS[T], key: slamdata.Predef.List[(FreeMap[T], FreeMap[T])], f: JoinType, combine: JoinFunc[T]) extends Product with Serializable

    This is an optional component of QScript that can be used instead of ThetaJoin.

    This is an optional component of QScript that can be used instead of ThetaJoin. It’s easier to implement, but more restricted (where ThetaJoin has an arbitrary predicate to determine if a pair of records should be combined, EquiJoin has an expression on each side that is compared with simple equality).

13.  trait ExpandMapFunc[IN[_]] extends Serializable
14.  sealed abstract class ExpandMapFuncInstances extends ExpandMapFuncInstancesʹ
15.  sealed abstract class ExpandMapFuncInstancesʹ extends AnyRef
16.  trait ExtractPath[F[_], P] extends AnyRef

    Extracts paths of particular type from QScript, collecting them in the provided ApplicativePlus.

17.  sealed abstract class ExtractPathInstances extends ExtractPathInstances0
18.  sealed abstract class ExtractPathInstances0 extends AnyRef
19.  final case class Filter[T[_[_]], A](src: A, f: FreeMap[T]) extends QScriptCore[T, A] with Product with Serializable

    Eliminates some values from a dataset, based on the result of f (which must evaluate to a boolean value for each element in the set).

20.  type FreeMap[T[_[_]]] = Free[[β$73$]Coproduct[[β$62$]MapFuncCore[T, β$62$], [β$63$]MapFuncDerived[T, β$63$], β$73$], Hole]
21.  type FreeMapA[T[_[_]], A] = Free[[β$73$]Coproduct[[β$62$]MapFuncCore[T, β$62$], [β$63$]MapFuncDerived[T, β$63$], β$73$], A]
22.  type FreeQS[T[_[_]]] = Free[[β$72$]Coproduct[[β$0$]QScriptCore[T, β$0$], [β$1$]Coproduct[[β$2$]ProjectBucket[T, β$2$], [β$3$]Coproduct[[β$4$]ThetaJoin[T, β$4$], [β$5$]Coproduct[[β$6$]EquiJoin[T, β$6$], [β$7$]Coproduct[[β$8$]Const[ShiftedRead[Path[Abs, Dir, Sandboxed]], β$8$], [β$9$]Coproduct[[β$10$]Const[ShiftedRead[Path[Abs, File, Sandboxed]], β$10$], [β$11$]Coproduct[[β$12$]Const[Read[Path[Abs, Dir, Sandboxed]], β$12$], [β$13$]Coproduct[[β$14$]Const[Read[Path[Abs, File, Sandboxed]], β$14$], [β$15$]Const[DeadEnd, β$15$], β$13$], β$11$], β$9$], β$7$], β$5$], β$3$], β$1$], β$72$], Hole]
23.  sealed abstract class Hole extends AnyRef
24.  sealed abstract class IdStatus extends AnyRef
25.  trait Injectable[IN[_]] extends AnyRef

    This is like scalaz.Inject, but for injecting an arbitrary coproduct where all of the components are in the OUT coproduct in any order.

    This is like scalaz.Inject, but for injecting an arbitrary coproduct where all of the components are in the OUT coproduct in any order.

    It _may_ be unprincipled (otherwise, why not allow scalaz.Inject to work this way directly?) But it is temporarily necessary in order to “inject” our more constrained versions of QScript into QScriptTotal.

26.  type JoinFunc[T[_[_]]] = Free[[β$73$]Coproduct[[β$62$]MapFuncCore[T, β$62$], [β$63$]MapFuncDerived[T, β$63$], β$73$], JoinSide]
27.  sealed abstract class JoinSide extends AnyRef
28.  sealed abstract class JoinSide3 extends AnyRef
29.  final case class LeftShift[T[_[_]], A](src: A, struct: FreeMap[T], idStatus: IdStatus, shiftType: ShiftType, onUndefined: OnUndefined, repair: JoinFunc[T]) extends QScriptCore[T, A] with Product with Serializable

    Flattens nested structure, converting each value into a data set, which are then unioned.

    Flattens nested structure, converting each value into a data set, which are then unioned.

    struct is an expression that evaluates to an array or object, which is then “exploded” into multiple values. idStatus indicates what each of those exploded values should look like (either just the value, just the “id” (i.e., the key or index), or a 2-element array of key and value). repair is applied across the new set, integrating the exploded values into the original set.

    onUndefined specifies how evaluation should proceeed when struct evaluates to Undefined. When Emit then the repair expression must be invoked once with RightSide set to Undefined, when Omit then the repair must not be invoked.

    E.g., in: LeftShift(x, ProjectKey(SrcHole, "bar"), ExcludeId, ConcatMaps(LeftSide, MakeMap("bar", RightSide))) If x consists of things that look like { foo: 7, bar: [1, 2, 3] }, then that’s what LeftSide is. And RightSide is values like 1, 2, and 3, because that’s what you get from flattening the struct.So then our right-biased quasar.qscript.MapFuncsCore.ConcatMaps says to concat { foo: 7, bar: [1, 2, 3] } with { bar: 1 }, resulting in { foo: 7, bar: 1 } (then again with { foo: 7, bar: 2 } and { foo: 7, bar: 3 }, finishing up the handling of that one element in the original (x) dataset.

30.  final case class Map[T[_[_]], A](src: A, f: FreeMap[T]) extends QScriptCore[T, A] with Product with Serializable

    A data-level transformation.

31.  type MapFunc[T[_[_]], A] = Coproduct[[β$62$]MapFuncCore[T, β$62$], [β$63$]MapFuncDerived[T, β$63$], A]
32.  sealed abstract class MapFuncCore[T[_[_]], A] extends AnyRef
33.  sealed abstract class MapFuncDerived[T[_[_]], A] extends AnyRef
34.  sealed abstract class Nullary[T[_[_]], A] extends MapFuncCore[T, A]
35.  sealed abstract class NullaryDerived[T[_[_]], A] extends MapFuncDerived[T, A]
36.  sealed abstract class OnUndefined extends AnyRef
37.  sealed abstract class ProjectBucket[T[_[_]], A] extends AnyRef

    Projections are technically dimensional (i.e., QScript) operations.

    Projections are technically dimensional (i.e., QScript) operations. However, to a filesystem, they are merely Map operations. So, we use these components while building the QScript plan and they are then used in static path processing, but they are replaced with equivalent MapFuncsCore before being processed by the filesystem.

38.  type QScript[T[_[_]], A] = Coproduct[[β$36$]QScriptCore[T, β$36$], [A]Coproduct[[β$34$]ThetaJoin[T, β$34$], [β$35$]Const[DeadEnd, β$35$], A], A]

    QScript that has not gone through Read conversion.

39.  sealed abstract class QScriptCore[T[_[_]], A] extends slamdata.Predef.Product with slamdata.Predef.Serializable
40.  type QScriptEducated[T[_[_]], A] = Coproduct[[β$23$]QScriptCore[T, β$23$], [A]Coproduct[[β$20$]ThetaJoin[T, β$20$], [A]Coproduct[[β$21$]Const[Read[Path[Abs, Dir, Sandboxed]], β$21$], [β$22$]Const[Read[Path[Abs, File, Sandboxed]], β$22$], A], A], A]

    Initial QScript.

41.  type QScriptRead[T[_[_]], A] = Coproduct[[β$45$]QScriptCore[T, β$45$], [A]Coproduct[[β$42$]ThetaJoin[T, β$42$], [A]Coproduct[[β$43$]Const[Read[Path[Abs, Dir, Sandboxed]], β$43$], [β$44$]Const[Read[Path[Abs, File, Sandboxed]], β$44$], A], A], A]

    QScript that has gone through Read conversion.

    QScript that has gone through Read conversion.

    NB: Once QScriptTotal goes away, this could become parametric in the path type.

42.  type QScriptShiftRead[T[_[_]], A] = Coproduct[[β$55$]QScriptCore[T, β$55$], [A]Coproduct[[β$52$]ThetaJoin[T, β$52$], [A]Coproduct[[β$53$]Const[ShiftedRead[Path[Abs, Dir, Sandboxed]], β$53$], [β$54$]Const[ShiftedRead[Path[Abs, File, Sandboxed]], β$54$], A], A], A]

    QScript that has gone through Read conversion and shifted conversion.

    QScript that has gone through Read conversion and shifted conversion.

    NB: Once QScriptTotal goes away, this could become parametric in the path type.

43.  type QScriptTotal[T[_[_]], A] = Coproduct[[β$0$]QScriptCore[T, β$0$], [β$1$]Coproduct[[β$2$]ProjectBucket[T, β$2$], [β$3$]Coproduct[[β$4$]ThetaJoin[T, β$4$], [β$5$]Coproduct[[β$6$]EquiJoin[T, β$6$], [β$7$]Coproduct[[β$8$]Const[ShiftedRead[Path[Abs, Dir, Sandboxed]], β$8$], [β$9$]Coproduct[[β$10$]Const[ShiftedRead[Path[Abs, File, Sandboxed]], β$10$], [β$11$]Coproduct[[β$12$]Const[Read[Path[Abs, Dir, Sandboxed]], β$12$], [β$13$]Coproduct[[β$14$]Const[Read[Path[Abs, File, Sandboxed]], β$14$], [β$15$]Const[DeadEnd, β$15$], β$13$], β$11$], β$9$], β$7$], β$5$], β$3$], β$1$], A]

    This type is _only_ used for join branch-like structures.

    This type is _only_ used for join branch-like structures. It’s an unfortunate consequence of not having mutually-recursive data structures. Once we do, this can go away. It should _not_ be used in other situations.

    NB: We're using the "alias" method of building the coproduct here as it provides a modest reduction in compilation time (~15%) for this module.

44.  type QScriptTotal0[T[_[_]], A] = Coproduct[[β$2$]ProjectBucket[T, β$2$], [β$3$]Coproduct[[β$4$]ThetaJoin[T, β$4$], [β$5$]Coproduct[[β$6$]EquiJoin[T, β$6$], [β$7$]Coproduct[[β$8$]Const[ShiftedRead[Path[Abs, Dir, Sandboxed]], β$8$], [β$9$]Coproduct[[β$10$]Const[ShiftedRead[Path[Abs, File, Sandboxed]], β$10$], [β$11$]Coproduct[[β$12$]Const[Read[Path[Abs, Dir, Sandboxed]], β$12$], [β$13$]Coproduct[[β$14$]Const[Read[Path[Abs, File, Sandboxed]], β$14$], [β$15$]Const[DeadEnd, β$15$], β$13$], β$11$], β$9$], β$7$], β$5$], β$3$], A]
45.  type QScriptTotal1[T[_[_]], A] = Coproduct[[β$4$]ThetaJoin[T, β$4$], [β$5$]Coproduct[[β$6$]EquiJoin[T, β$6$], [β$7$]Coproduct[[β$8$]Const[ShiftedRead[Path[Abs, Dir, Sandboxed]], β$8$], [β$9$]Coproduct[[β$10$]Const[ShiftedRead[Path[Abs, File, Sandboxed]], β$10$], [β$11$]Coproduct[[β$12$]Const[Read[Path[Abs, Dir, Sandboxed]], β$12$], [β$13$]Coproduct[[β$14$]Const[Read[Path[Abs, File, Sandboxed]], β$14$], [β$15$]Const[DeadEnd, β$15$], β$13$], β$11$], β$9$], β$7$], β$5$], A]
46.  type QScriptTotal2[T[_[_]], A] = Coproduct[[β$6$]EquiJoin[T, β$6$], [β$7$]Coproduct[[β$8$]Const[ShiftedRead[Path[Abs, Dir, Sandboxed]], β$8$], [β$9$]Coproduct[[β$10$]Const[ShiftedRead[Path[Abs, File, Sandboxed]], β$10$], [β$11$]Coproduct[[β$12$]Const[Read[Path[Abs, Dir, Sandboxed]], β$12$], [β$13$]Coproduct[[β$14$]Const[Read[Path[Abs, File, Sandboxed]], β$14$], [β$15$]Const[DeadEnd, β$15$], β$13$], β$11$], β$9$], β$7$], A]
47.  type QScriptTotal3[T[_[_]], A] = Coproduct[[β$8$]Const[ShiftedRead[Path[Abs, Dir, Sandboxed]], β$8$], [β$9$]Coproduct[[β$10$]Const[ShiftedRead[Path[Abs, File, Sandboxed]], β$10$], [β$11$]Coproduct[[β$12$]Const[Read[Path[Abs, Dir, Sandboxed]], β$12$], [β$13$]Coproduct[[β$14$]Const[Read[Path[Abs, File, Sandboxed]], β$14$], [β$15$]Const[DeadEnd, β$15$], β$13$], β$11$], β$9$], A]
48.  type QScriptTotal4[T[_[_]], A] = Coproduct[[β$10$]Const[ShiftedRead[Path[Abs, File, Sandboxed]], β$10$], [β$11$]Coproduct[[β$12$]Const[Read[Path[Abs, Dir, Sandboxed]], β$12$], [β$13$]Coproduct[[β$14$]Const[Read[Path[Abs, File, Sandboxed]], β$14$], [β$15$]Const[DeadEnd, β$15$], β$13$], β$11$], A]
49.  type QScriptTotal5[T[_[_]], A] = Coproduct[[β$12$]Const[Read[Path[Abs, Dir, Sandboxed]], β$12$], [β$13$]Coproduct[[β$14$]Const[Read[Path[Abs, File, Sandboxed]], β$14$], [β$15$]Const[DeadEnd, β$15$], β$13$], A]
50.  type QScriptTotal6[T[_[_]], A] = Coproduct[[β$14$]Const[Read[Path[Abs, File, Sandboxed]], β$14$], [β$15$]Const[DeadEnd, β$15$], A]
51.  final case class Read[A](path: A) extends Product with Serializable

    A backend-resolved Root, which is now a path.

52.  sealed trait RecFreeS[F[_], A] extends slamdata.Predef.Product with slamdata.Predef.Serializable
53.  final case class Reduce[T[_[_]], A](src: A, bucket: slamdata.Predef.List[FreeMap[T]], reducers: slamdata.Predef.List[ReduceFunc[FreeMap[T]]], repair: FreeMapA[T, ReduceIndex]) extends QScriptCore[T, A] with Product with Serializable

    Performs a reduction over a dataset, with the dataset partitioned by the result of the bucket MapFuncCore.

    Performs a reduction over a dataset, with the dataset partitioned by the result of the bucket MapFuncCore. So, rather than many-to-one, this is many-to-fewer.

    bucket partitions the values into buckets based on the result of the expression, reducers applies the provided reduction to each expression, and repair finally turns those reduced expressions into a final value.

    ReduceIndex is guaranteed to be a valid index into reducers.

54.  sealed abstract class ReduceFunc[A] extends AnyRef
55.  final case class ReduceIndex(idx: \/[slamdata.Predef.Int, slamdata.Predef.Int]) extends Product with Serializable

    Left indexes into the bucket.

    Left indexes into the bucket. Right indexes into the reducers.

56.  sealed abstract class SelectionOp extends AnyRef
57.  sealed trait ShiftType extends Product with Serializable
58.  final case class ShiftedRead[A](path: A, idStatus: IdStatus) extends Product with Serializable

    Similar to Read, but returns a dataset with an entry for each record.

    Similar to Read, but returns a dataset with an entry for each record. If idStatus is IncludeId, then it returns a two-element array for each record, with the id at element 0 and the record itself at element 1. If it’s ExcludeId, then it simply returns the record.

59.  final case class Sort[T[_[_]], A](src: A, bucket: slamdata.Predef.List[FreeMap[T]], order: NonEmptyList[(FreeMap[T], SortDir)]) extends QScriptCore[T, A] with Product with Serializable

    Sorts values within a bucket.

    Sorts values within a bucket. This can be an _unstable_ sort, but the elements of order must be stably sorted.

60.  final case class Subset[T[_[_]], A](src: A, from: FreeQS[T], op: SelectionOp, count: FreeQS[T]) extends QScriptCore[T, A] with Product with Serializable

    Chooses a subset of values from a dataset, given a count.

61.  trait TTypes[T[_[_]]] extends AnyRef

    Centralizes the knowledge of T[_[_]].

    Centralizes the knowledge of T[_[_]]. This is for compilation performance.

62.  sealed abstract class Ternary[T[_[_]], A] extends MapFuncCore[T, A]
63.  sealed abstract class TernaryDerived[T[_[_]], A] extends MapFuncDerived[T, A]
64.  final case class ThetaJoin[T[_[_]], A](src: A, lBranch: FreeQS[T], rBranch: FreeQS[T], on: JoinFunc[T], f: JoinType, combine: JoinFunc[T]) extends Product with Serializable

    Applies a function across two datasets, in the cases where the JoinFunc evaluates to true.

    Applies a function across two datasets, in the cases where the JoinFunc evaluates to true. The branches represent the divergent operations applied to some common src. Each branch references the src exactly once. (Since no constructor has more than one recursive component, it’s guaranteed that neither side references the src _more_ than once.)

    This case represents a full θJoin, but we could have an algebra that rewrites it as Filter(_, EquiJoin(...)) to simplify behavior for the backend.

65.  trait Trans[F[_], M[_]] extends AnyRef
66.  sealed abstract class Unary[T[_[_]], A] extends MapFuncCore[T, A]
67.  sealed abstract class UnaryDerived[T[_[_]], A] extends MapFuncDerived[T, A]
68.  trait UnaryFunctions[T[_[_]], IN[_]] extends AnyRef
69.  final case class Union[T[_[_]], A](src: A, lBranch: FreeQS[T], rBranch: FreeQS[T]) extends QScriptCore[T, A] with Product with Serializable

    Creates a new dataset that contains the elements from the datasets created by each branch.

    Creates a new dataset that contains the elements from the datasets created by each branch. Duplicate values should not be eliminated.

70.  final case class Unreferenced[T[_[_]], A]() extends QScriptCore[T, A] with Product with Serializable

    A placeholder value that can appear in plans, but will never be referenced in the result.

    A placeholder value that can appear in plans, but will never be referenced in the result. We consider this a wart. It should be implemented as an arbitrary value (of cardinality 1) with minimal cost to generate (since it will simply be discarded).