moonrockz/partiql-eval/plan

README
U
Clock
U
EvalError
U
Mode
U
ZoneOffset
E
SessionError
- ::emptyBindings::empty
- ::from_ion_bytesBindings::from_ion_bytes
- ::from_ion_textBindings::from_ion_text
- ::of_ionBindings::of_ion
- ::of_pairsBindings::of_pairs
- ::of_tupleBindings::of_tuple
- ::with_dataBindings::with_data
- ::with_valueBindings::with_value
- ::SessionSession::Session
- ::evaluateSession::evaluate
- ::evaluate_eachSession::evaluate_each
- ::evaluate_ion_bytesSession::evaluate_ion_bytes
- ::evaluate_ion_textSession::evaluate_ion_text
- ::evaluate_scriptSession::evaluate_script
V
evaluate
V
evaluate_text

moonrockz/partiql-eval/plan does not have a README file

EvalError

pub(all) suberror EvalError {
  TypeError(message~ : String, span~ : @moonrockz/partiql-syntax/ast.Span
Span)
  DataError(message~ : String, span~ : @moonrockz/partiql-syntax/ast.Span
Span)
  Unsupported(message~ : String, span~ : @moonrockz/partiql-syntax/ast.Span
Span)
  Syntax(@moonrockz/partiql-syntax/ast.ParseError
ParseError)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

An evaluation failure with a source location, or the original parse error. TypeError is a strict-mode operand failure; DataError is invalid data or a static error in either mode; Unsupported is an unimplemented form.

AggregateKind

source

pub(all) enum AggregateKind {
  Count
  Sum
  Avg
  Min
  Max
  Any
  Every
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

An aggregate function (spec M4c §3.3). SOME is Any.

Expr

source

pub(all) enum Expr {
  Const(@moonrockz/partiql-value.Value
Value, @moonrockz/partiql-syntax/ast.Span
Span)
  Global(String, delimited~ : Bool, @moonrockz/partiql-syntax/ast.Span
Span)
  ListOf(Array[Expr], @moonrockz/partiql-syntax/ast.Span
Span)
  BagOf(Array[Expr], @moonrockz/partiql-syntax/ast.Span
Span)
  TupleOf(Array[(Expr, Expr)], @moonrockz/partiql-syntax/ast.Span
Span)
  MapOf(Array[(Expr, Expr)], key_type~ : @moonrockz/partiql-value.MapType
MapType?, value_type~ : @moonrockz/partiql-value.MapType
MapType?, @moonrockz/partiql-syntax/ast.Span
Span)
  Path(Expr, Array[Step], @moonrockz/partiql-syntax/ast.Span
Span)
  IsNull(Expr, negated~ : Bool, @moonrockz/partiql-syntax/ast.Span
Span)
  IsMissing(Expr, negated~ : Bool, @moonrockz/partiql-syntax/ast.Span
Span)
  Unary(@moonrockz/partiql-syntax/ast.UnaryOp
UnaryOp, Expr, @moonrockz/partiql-syntax/ast.Span
Span)
  Binary(@moonrockz/partiql-syntax/ast.BinaryOp
BinaryOp, Expr, Expr, @moonrockz/partiql-syntax/ast.Span
Span)
  And(Expr, Expr, @moonrockz/partiql-syntax/ast.Span
Span)
  Or(Expr, Expr, @moonrockz/partiql-syntax/ast.Span
Span)
  Not(Expr, @moonrockz/partiql-syntax/ast.Span
Span)
  BoolTest(Expr, Bool?, negated~ : Bool, @moonrockz/partiql-syntax/ast.Span
Span)
  Like(Expr, pattern~ : Expr, escape~ : Expr?, negated~ : Bool, @moonrockz/partiql-syntax/ast.Span
Span)
  Between(Expr, low~ : Expr, high~ : Expr, negated~ : Bool, @moonrockz/partiql-syntax/ast.Span
Span)
  In(Expr, Expr, negated~ : Bool, @moonrockz/partiql-syntax/ast.Span
Span)
  IsType(Expr, @moonrockz/partiql-syntax/ast.DataType
DataType, negated~ : Bool, @moonrockz/partiql-syntax/ast.Span
Span)
  Case(operand~ : Expr?, branches~ : Array[(Expr, Expr)], default~ : Expr?, @moonrockz/partiql-syntax/ast.Span
Span)
  Coalesce(Array[Expr], @moonrockz/partiql-syntax/ast.Span
Span)
  NullIf(Expr, Expr, @moonrockz/partiql-syntax/ast.Span
Span)
  Call(Function, Array[Expr], @moonrockz/partiql-syntax/ast.Span
Span)
  Cast(Expr, @moonrockz/partiql-eval/ops.CastTarget
CastTarget, @moonrockz/partiql-syntax/ast.Span
Span)
  Local(String, @moonrockz/partiql-syntax/ast.Span
Span)
  GlobalOrLocal(String, variable~ : LocalLookup, delimited~ : Bool, @moonrockz/partiql-syntax/ast.Span
Span)
  Implicit(String, delimited~ : Bool, locals~ : Array[String], @moonrockz/partiql-syntax/ast.Span
Span)
  Select(Rel, Projection, distinct~ : Bool, @moonrockz/partiql-syntax/ast.Span
Span)
  Subquery(Expr, SubqueryUse, @moonrockz/partiql-syntax/ast.Span
Span)
  Query(Expr, order~ : Array[SortKey], limit~ : Expr?, offset~ : Expr?, aliases~ : Array[String], @moonrockz/partiql-syntax/ast.Span
Span)
  SetOp(@moonrockz/partiql-syntax/ast.SetOpKind
SetOpKind, all~ : Bool, outer~ : Bool, corresponding~ : @moonrockz/partiql-syntax/ast.Corresponding
Corresponding?, Expr, Expr, @moonrockz/partiql-syntax/ast.Span
Span)
  With(Array[(String, Expr)], Expr, @moonrockz/partiql-syntax/ast.Span
Span)
  CollAggregate(AggregateKind, distinct~ : Bool, Expr, @moonrockz/partiql-syntax/ast.Span
Span)
  Aggregate(AggregateKind, distinct~ : Bool, Expr, members~ : Array[String], group~ : String, @moonrockz/partiql-syntax/ast.Span
Span)
  GlobalsFirst(Array[(String, Bool, @moonrockz/partiql-syntax/ast.Span
Span)], key~ : Expr, otherwise~ : Expr, @moonrockz/partiql-syntax/ast.Span
Span)
} derive(@moonbitlang/core/debug.Debug
Debug)

A lowered scalar expression (spec M4a §3). Names are resolved, literals are values.

Expr::span

source

fn Expr::span(self : Expr) -> @moonrockz/partiql-syntax/ast.Span
Span

Where an expression is in the source.

Function

source

pub(all) enum Function {
  CharLength
  OctetLength
  BitLength
  Size
  Cardinality
  Exists
  TupleUnion
  MapGet
  MapContainsKey
  MapKeys
  MapValues
  MapEntries
  Abs
  Mod
  Trim(@moonrockz/partiql-syntax/ast.TrimSpec
TrimSpec)
  Substring
  Position
  Overlay
  TextReplace
  Upper
  Lower
  Extract(@moonrockz/partiql-syntax/ast.DatetimeField
DatetimeField)
  DateAdd(@moonrockz/partiql-syntax/ast.DatetimeField
DatetimeField)
  DateDiff(@moonrockz/partiql-syntax/ast.DatetimeField
DatetimeField)
  Overlaps
  ToString
  ToTimestamp
  CurrentDate
  CurrentTime(Int)
  CurrentTimestamp(Int)
  UtcNow
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

A built-in scalar function (spec M4d1). One argument unless a variant says otherwise.

Function::name

source

fn Function::name(self : Function) -> String

The SQL name, for messages.

Grouping

source

pub(all) enum Grouping {
  All
  By(Array[(String, Expr)])
} derive(@moonbitlang/core/debug.Debug
Debug)

The keys of a GROUP BY (spec M4c §4).

Item

source

pub(all) enum Item {
  Named(String, Expr)
  AllFields(Expr)
} derive(@moonbitlang/core/debug.Debug
Debug)

An item of a SELECT list.

JoinKind

source

pub(all) enum JoinKind {
  Cross
  Inner
  Left
  Right
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

A lowered join strategy. Left and right outer joins pad unmatched bindings with NULL; cross and inner joins produce only matching pairs.

LocalLookup

source

pub(all) enum LocalLookup {
  Bound(String)
  Ambiguous(Array[String])
} derive(@moonbitlang/core/debug.Debug
Debug)

The local fallback of a FROM source after global lookup has failed.

Mode

source

pub(all) enum Mode {
  Permissive
  Strict
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

How the interpreter handles runtime type failures. Permissive mode yields MISSING; strict mode raises TypeError. Data and unsupported-form failures raise in either mode.

Projection

source

pub(all) enum Projection {
  Value(Expr)
  Items(Array[Item])
  Star(Array[String])
  Pivot(value~ : Expr, key~ : Expr)
} derive(@moonbitlang/core/debug.Debug
Debug)

What a query block makes of each binding tuple.

Rel

source

pub(all) enum Rel {
  Scan(Expr, as_~ : String, at~ : String?, @moonrockz/partiql-syntax/ast.Span
Span)
  Unpivot(Expr, as_~ : String, at~ : String?, @moonrockz/partiql-syntax/ast.Span
Span)
  Filter(Rel, Expr, @moonrockz/partiql-syntax/ast.Span
Span)
  Join(JoinKind, Rel, Rel, on~ : Expr?, @moonrockz/partiql-syntax/ast.Span
Span)
  Let(Rel, Array[(String, Expr)], @moonrockz/partiql-syntax/ast.Span
Span)
  Group(Rel, Grouping, group_as~ : String, members~ : Array[String], @moonrockz/partiql-syntax/ast.Span
Span)
} derive(@moonbitlang/core/debug.Debug
Debug)

A relational plan node (spec M4b1 §3): it produces binding tuples.

Rel::span

source

fn Rel::span(self : Rel) -> @moonrockz/partiql-syntax/ast.Span
Span

Where a relation is in the source.

SortKey

source

pub(all) struct SortKey {
  expr : Expr
  desc : Bool
  nulls_first : Bool
} derive(@moonbitlang/core/debug.Debug
Debug)

A key of ORDER BY. nulls_first is resolved: the explicit NULLS FIRST or NULLS LAST, else NULL and MISSING come last for ASC and first for DESC.

Step

source

pub(all) enum Step {
  Field(String, delimited~ : Bool)
  Index(Expr)
  AllElements
  AllFields
} derive(@moonbitlang/core/debug.Debug
Debug)

One step of a path.

SubqueryUse

source

pub(all) enum SubqueryUse {
  Scalar
  Column
  Row
} derive(@moonbitlang/core/debug.Debug
Debug)

How a single-column subquery is coerced at its use site. Each variant defines its empty-input and cardinality behavior.

group_variable

source

let group_variable : String

The group variable of a grouped query without GROUP AS. No identifier can name it.

output_variable

source

fn output_variable(name : String) -> String

The name of the frame that holds the output name name of a SELECT list while ORDER BY runs: apart from every variable name.

row_variable

source

let row_variable : String

The variable that holds an output element for the sort keys of a query whose body is not a SELECT. No identifier can name it.

Source Files

plan.mbt

Site source Report issue Packages Build queue Skills Statistics

#EvalError

#AggregateKind

#Expr

#Expr::span

#Function

#Function::name

#Grouping

#Item

#JoinKind

#LocalLookup

#Mode

#Projection

#Rel

#Rel::span

#SortKey

#Step

#SubqueryUse

#group_variable

#output_variable

#row_variable

Source Files

EvalError

AggregateKind

Expr

Expr::span

Function

Function::name

Grouping

Item

JoinKind

LocalLookup

Mode

Projection

Rel

Rel::span

SortKey

Step

SubqueryUse

group_variable

output_variable

row_variable