README
E
DateTimeError
E
GraphError
E
IntervalError
E
LowerError
E
MapError
- ::itemsBag::items
- ::lengthBag::length
- ::newBag::new
- ::newDate::new
T
Ends
- ::labelsGraphEdge::labels
- ::newGraphEdge::new
- ::labelsGraphNode::labels
- ::newGraphNode::new
- ::edgesGraphValue::edges
- ::newGraphValue::new
- ::nodesGraphValue::nodes
- ::daysIntervalDT::days
- ::from_partsIntervalDT::from_parts
- ::hoursIntervalDT::hours
- ::is_negativeIntervalDT::is_negative
- ::minutesIntervalDT::minutes
- ::nanos_partIntervalDT::nanos_part
- ::newIntervalDT::new
- ::seconds_partIntervalDT::seconds_part
- ::from_partsIntervalYM::from_parts
- ::is_negativeIntervalYM::is_negative
- ::months_partIntervalYM::months_part
- ::newIntervalYM::new
- ::yearsIntervalYM::years
- ::from_nameMapType::from_name
- ::nameMapType::name
- ::entriesMapValue::entries
- ::lengthMapValue::length
- ::newMapValue::new
T
NullOrder
- ::newTime::new
- ::newTimestamp::new
- ::fieldsTuple::fields
- ::get_allTuple::get_all
- ::lengthTuple::length
- ::newTuple::new
- ::integerValue::integer
- ::is_absentValue::is_absent
- ::lowerValue::lower
- ::lower_deepValue::lower_deep
V
compare
V
eqg
V
sql_equals
V
timestamp_of_ion

partiql-value

The PartiQL data model for MoonBit, with a PartiQL-encoded Ion codec.

partiql

sql

query

ion

data-model

Download zip

Author

moonrockz

Version

0.1.0

License

Apache-2.0

Repository

github.com/moonrockz/partiql

Last updated

5 hours ago

Downloads

Dependencies

moonrockz/ion0.2.0
moonrockz/expect0.6.0

#moonrockz/partiql-value

The PartiQL data model for MoonBit, with the PartiQL-encoded Ion codec that the partiql-tests suite uses.

#Packages

Package	Alias	Content
moonrockz/partiql-value	@value	Value, Tuple, Bag, MapValue (RFC 0104), GraphValue (RFC 0025), Date, Time, Timestamp, IntervalYM, IntervalDT, and the relations ==, sql_equals, eqg, compare
moonrockz/partiql-value/ion	@partiql_ion	from_ion, to_ion (PartiQL-encoded Ion, as in partiql-tests); from_ion_data, to_ion_data (Ion-preserving: Ion data passes through exactly)
moonrockz/partiql-value/arbitrary	@arbitrary	quickcheck generators for property-based tests

#Example

let bag = @value.Value::Bag(@value.Bag::new([@value.Value::Int(1L), @value.Value::Int(2L)]))
let same = @value.Value::Bag(@value.Bag::new([@value.Value::Int(2L), @value.Value::Int(1L)]))
@value.sql_equals(bag, same) // Bool(true): bags compare as multisets

// A tuple never holds MISSING: the constructor drops the pair.
let t = @value.Tuple::new([("a", @value.Value::Missing), ("b", @value.Value::Null)])
t.length() // 1

// Boxed Ion values compare by their lowered value: an Ion symbol equals a string.
let symbol = @value.Value::Ion(@ion_core.IonValue::symbol("hello"))
@value.sql_equals(symbol, @value.Value::String("hello")) // Bool(true)

// PartiQL-encoded Ion.
@partiql_ion.to_ion(bag) // $bag::[1, 2]

#Relations

Relation	Use
== (Eq)	Structural identity: same case and contents; bags and tuples as multisets; decimal scale counts
sql_equals	The PartiQL = operator: MISSING beats NULL; numbers compare by value across types
eqg	Grouping equivalence: NULL eqg NULL, MISSING eqg MISSING, NaN eqg NaN
compare	The ORDER BY total order, with NullsFirst or NullsLast

See docs/architecture.md and ADR 0005 in the repository.

DateTimeError

source

pub(all) suberror DateTimeError {
  InvalidDate(String)
  InvalidTime(String)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

A date, time or timestamp field that is out of range.

GraphError

source

pub(all) suberror GraphError {
  DuplicateNodeId(String)
  DuplicateEdgeId(String)
  UnknownNode(String)
  MissingPayload(String)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Why a graph could not be built.

IntervalError

source

pub(all) suberror IntervalError {
  Overflow(String)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

An interval that does not fit the representation.

LowerError

source

pub(all) suberror LowerError {
  SymbolWithoutText
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

An Ion value that has no PartiQL equivalent.

MapError

source

pub(all) suberror MapError {
  InvalidKey(String)
  DuplicateKey(String)
  DynamicKeyType
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Why a MAP could not be built.

Bag

source

pub struct Bag {
  // private fields
} derive(@moonbitlang/core/debug.Debug
Debug)

A PartiQL bag: an unordered collection that allows duplicates.

impl Eq for Bag

Bag::items

source

fn Bag::items(self : Bag) -> ArrayView[Value]

Bag::length

source

fn Bag::length(self : Bag) -> Int

Bag::new

source

fn Bag::new(items : Array[Value]) -> Bag

Date

source

pub struct Date {
  year : Int
  month : Int
  day : Int
} derive(@moonbitlang/core/debug.Debug
Debug)

A calendar date (proleptic Gregorian).

impl Eq for Date

Date::new

source

fn Date::new(year~ : Int, month~ : Int, day~ : Int) -> Date raise DateTimeError

Ends

source

pub(all) enum Ends {
  Directed(from~ : String, to~ : String)
  Undirected(String, String)
} derive(@moonbitlang/core/debug.Debug
Debug)

The ends of a graph edge (RFC 0025): an ordered pair for a directed edge, an unordered pair for an undirected edge. Ends name node ids.

impl Eq for Ends

GraphEdge

source

pub struct GraphEdge {
  id : String
  ends : Ends
  payload : Value?
  // private fields
} derive(@moonbitlang/core/debug.Debug
Debug)

A graph edge: id, labels, ends and an optional payload.

GraphEdge::labels

source

fn GraphEdge::labels(self : GraphEdge) -> ArrayView[String]

The labels, without duplicates, in first-seen order.

GraphEdge::new

source

fn GraphEdge::new(id~ : String, ends~ : Ends, labels? : Array[String], payload? : Value?) -> GraphEdge

GraphNode

source

pub struct GraphNode {
  id : String
  payload : Value?
  // private fields
} derive(@moonbitlang/core/debug.Debug
Debug)

A graph node: its id from the source data, its labels (a set, kept in first-seen order) and an optional payload. An absent payload is not NULL: it acts as MISSING in queries.

GraphNode::labels

source

fn GraphNode::labels(self : GraphNode) -> ArrayView[String]

The labels, without duplicates, in first-seen order.

GraphNode::new

source

fn GraphNode::new(id~ : String, labels? : Array[String], payload? : Value?) -> GraphNode

GraphValue

source

pub struct GraphValue {
  // private fields
} derive(@moonbitlang/core/debug.Debug
Debug)

A PartiQL graph (RFC 0025). Node ids are unique among nodes, edge ids among edges (two namespaces), and every edge end names a node.

impl Eq for GraphValue

GraphValue::edges

source

fn GraphValue::edges(self : GraphValue) -> ArrayView[GraphEdge]

GraphValue::new

source

fn GraphValue::new(nodes : Array[GraphNode], edges : Array[GraphEdge]) -> GraphValue raise GraphError

GraphValue::nodes

source

fn GraphValue::nodes(self : GraphValue) -> ArrayView[GraphNode]

IntervalDT

source

pub struct IntervalDT {
  seconds : Int64
  nanos : Int
} derive(@moonbitlang/core/debug.Debug
Debug)

A day-time interval: seconds + nanos / 10^9, with nanos in 0..999,999,999 (floor form).

impl Eq for IntervalDT

IntervalDT::days

source

fn IntervalDT::days(self : IntervalDT) -> Int64

IntervalDT::from_parts

source

fn IntervalDT::from_parts(negative~ : Bool, days~ : Int64, hours~ : Int64, minutes~ : Int64, seconds~ : Int64, nanos~ : Int64) -> IntervalDT raise IntervalError

IntervalDT::hours

source

fn IntervalDT::hours(self : IntervalDT) -> Int64

IntervalDT::is_negative

source

fn IntervalDT::is_negative(self : IntervalDT) -> Bool

IntervalDT::minutes

source

fn IntervalDT::minutes(self : IntervalDT) -> Int64

IntervalDT::nanos_part

source

fn IntervalDT::nanos_part(self : IntervalDT) -> Int64

IntervalDT::new

source

fn IntervalDT::new(seconds : Int64, nanos : Int64) -> IntervalDT raise IntervalError

IntervalDT::seconds_part

source

fn IntervalDT::seconds_part(self : IntervalDT) -> Int64

IntervalYM

source

pub struct IntervalYM {
  months : Int64
} derive(@moonbitlang/core/debug.Debug
Debug)

A year-month interval, as a signed number of months.

impl Eq for IntervalYM

IntervalYM::from_parts

source

fn IntervalYM::from_parts(negative~ : Bool, years~ : Int64, months~ : Int64) -> IntervalYM raise IntervalError

IntervalYM::is_negative

source

fn IntervalYM::is_negative(self : IntervalYM) -> Bool

IntervalYM::months_part

source

fn IntervalYM::months_part(self : IntervalYM) -> Int64

IntervalYM::new

source

fn IntervalYM::new(months : Int64) -> IntervalYM raise IntervalError

IntervalYM::years

source

fn IntervalYM::years(self : IntervalYM) -> Int64

MapType

source

pub(all) enum MapType {
  Dynamic
  Bool
  TinyInt
  SmallInt
  Integer
  BigInt
  Numeric
  Decimal
  Real
  Double
  String
  Char
  Varchar
  Date
  Time
  Timestamp
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

The declared key or value type of a MAP (RFC 0104). The names are the static type names of partiql-tests' $map::<key>::<value>:: encoding.

MapType::from_name

source

fn MapType::from_name(name : String) -> MapType?

The type for a name; int is accepted for integer.

MapType::name

source

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

The type name as partiql-tests writes it.

MapValue

source

pub struct MapValue {
  key_type : MapType
  value_type : MapType
  // private fields
} derive(@moonbitlang/core/debug.Debug
Debug)

A PartiQL MAP: unique scalar keys, no MISSING values. The stored order is the insertion order (for output); equality and ordering ignore it.

impl Eq for MapValue

MapValue::entries

source

fn MapValue::entries(self : MapValue) -> ArrayView[(Value, Value)]

MapValue::length

source

fn MapValue::length(self : MapValue) -> Int

MapValue::new

source

fn MapValue::new(key_type~ : MapType, value_type~ : MapType, entries : Array[(Value, Value)]) -> MapValue raise MapError

Builds a MAP. Entries whose value is MISSING are dropped (RFC 0104). Keys are lowered first; NULL, MISSING and non-scalar keys, and keys equal under eqg to an earlier key, raise.

NullOrder

source

pub(all) enum NullOrder {
  NullsFirst
  NullsLast
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Where NULL and MISSING sort.

Time

source

pub struct Time {
  hour : Int
  minute : Int
  second : Int
  nanos : Int
  precision : Int
  offset : Int?
} derive(@moonbitlang/core/debug.Debug
Debug)

A time of day. offset is minutes east of UTC; None means WITHOUT TIME ZONE. precision is the number of fractional-second digits (TIME(p)).

impl Eq for Time

Time::new

source

fn Time::new(hour~ : Int, minute~ : Int, second~ : Int, nanos? : Int, precision? : Int, offset? : Int?) -> Time raise DateTimeError

Timestamp

source

pub struct Timestamp {
  date : Date
  time : Time
} derive(@moonbitlang/core/debug.Debug
Debug)

A date and a time. The time's offset is the timestamp's offset.

impl Eq for Timestamp

Timestamp::new

source

fn Timestamp::new(date : Date, time : Time) -> Timestamp

Tuple

source

pub struct Tuple {
  // private fields
} derive(@moonbitlang/core/debug.Debug
Debug)

A PartiQL tuple: (name, value) pairs. Order is kept for output only; duplicate names are allowed; no value is MISSING.

impl Eq for Tuple

Tuple::fields

source

fn Tuple::fields(self : Tuple) -> ArrayView[(String, Value)]

Tuple::get_all

source

fn Tuple::get_all(self : Tuple, name : String) -> Array[Value]

The values of the attributes named name (case-sensitive).

Tuple::length

source

fn Tuple::length(self : Tuple) -> Int

Tuple::new

source

fn Tuple::new(fields : Array[(String, Value)]) -> Tuple

Builds a tuple. Pairs whose value is MISSING are dropped.

Value

source

pub(all) enum Value {
  Null
  Missing
  Bool(Bool)
  Int(Int64)
  BigInt(@moonbitlang/core/bigint.BigInt
BigInt)
  Float(Double)
  Decimal(@moonrockz/ion/ion.Decimal
Decimal)
  String(String)
  Clob(Bytes)
  Blob(Bytes)
  Date(Date)
  Time(Time)
  Timestamp(Timestamp)
  IntervalYM(IntervalYM)
  IntervalDT(IntervalDT)
  List(Array[Value])
  Bag(Bag)
  Tuple(Tuple)
  Map(MapValue)
  Graph(GraphValue)
  Ion(@moonrockz/ion/ion.IonValue
IonValue)
} derive(@moonbitlang/core/debug.Debug
Debug)

A PartiQL value.

Ion holds an exact Ion value (from a backtick literal or $ion::). It is a representation, never a PartiQL type: every semantic acts on its lowered value (see Value::lower).

impl Eq for Value

Value::integer

source

fn Value::integer(n : @moonbitlang/core/bigint.BigInt
BigInt) -> Value

An integer value: Int when it fits in Int64, else BigInt.

Value::is_absent

source

fn Value::is_absent(self : Value) -> Bool

Whether the value is NULL or MISSING.

Value::lower

source

fn Value::lower(self : Value) -> Value raise LowerError

Converts a boxed Ion value to its core value, one level deep. Other values are returned unchanged.

Value::lower_deep

source

fn Value::lower_deep(self : Value) -> Value raise LowerError

Lowers recursively, including the children of collections and tuples.

compare

source

fn compare(a : Value, b : Value, nulls~ : NullOrder) -> Int

The ORDER BY total order (spec section 4.4). Returns -1, 0 or 1.

eqg

source

fn eqg(a : Value, b : Value) -> Bool

Grouping equivalence: NULL eqg NULL, MISSING eqg MISSING, NaN eqg NaN; otherwise the same as =.

sql_equals

source

fn sql_equals(a : Value, b : Value) -> Value

The PartiQL = operator: MISSING if either side is MISSING, else NULL if either side is NULL, else a Bool. Never fails on mixed types.

timestamp_of_ion

source

fn timestamp_of_ion(ts : @moonrockz/ion/ion.Timestamp
Timestamp) -> Timestamp

Converts an Ion timestamp: missing fields become 0, an unknown offset becomes UTC, and more than 9 fractional digits are truncated.

Source Files

Site source Report issue Packages Build queue Skills Statistics

partiql-value

#moonrockz/partiql-value

#Packages

#Example

#Relations

#DateTimeError

#GraphError

#IntervalError

#LowerError

#MapError

#Bag

#Bag::items

#Bag::length

#Bag::new

#Date

#Date::new

#Ends

#GraphEdge

#GraphEdge::labels

#GraphEdge::new

#GraphNode

#GraphNode::labels

#GraphNode::new

#GraphValue

#GraphValue::edges

#GraphValue::new

#GraphValue::nodes

#IntervalDT

#IntervalDT::days

#IntervalDT::from_parts

#IntervalDT::hours

#IntervalDT::is_negative

#IntervalDT::minutes

#IntervalDT::nanos_part

#IntervalDT::new

#IntervalDT::seconds_part

#IntervalYM

#IntervalYM::from_parts

#IntervalYM::is_negative

#IntervalYM::months_part

#IntervalYM::new

#IntervalYM::years

#MapType

#MapType::from_name

#MapType::name

#MapValue

#MapValue::entries

#MapValue::length

#MapValue::new

#NullOrder

#Time

#Time::new

#Timestamp

#Timestamp::new

#Tuple

#Tuple::fields

#Tuple::get_all

#Tuple::length

#Tuple::new

#Value

#Value::integer

#Value::is_absent

#Value::lower

#Value::lower_deep

#compare

#eqg

#sql_equals

#timestamp_of_ion

Source Files

DateTimeError

GraphError

IntervalError

LowerError

MapError

Bag

Bag::items

Bag::length

Bag::new

Date

Date::new

Ends

GraphEdge

GraphEdge::labels

GraphEdge::new

GraphNode

GraphNode::labels

GraphNode::new

GraphValue

GraphValue::edges

GraphValue::new

GraphValue::nodes

IntervalDT

IntervalDT::days

IntervalDT::from_parts

IntervalDT::hours

IntervalDT::is_negative

IntervalDT::minutes

IntervalDT::nanos_part

IntervalDT::new

IntervalDT::seconds_part

IntervalYM

IntervalYM::from_parts

IntervalYM::is_negative

IntervalYM::months_part

IntervalYM::new

IntervalYM::years

MapType

MapType::from_name

MapType::name

MapValue

MapValue::entries

MapValue::length

MapValue::new

NullOrder

Time

Time::new

Timestamp

Timestamp::new

Tuple

Tuple::fields

Tuple::get_all

Tuple::length

Tuple::new

Value

Value::integer

Value::is_absent

Value::lower

Value::lower_deep

compare

eqg

sql_equals

timestamp_of_ion