'db' Dialect

Imperative Database Dialect

Imperative database dialect, defining abstract/non-trivial types and high-level operations which more closely resemble SQL semantics, e.g. by supporting NULL values.

Supported types are integers (i32/i64), floats, bools (i1), Date, Timestamp, Interval, Decimal, Char (fixed-size buffers), and String (variable-length buffers). Nullable types are supported using nullable<...>; plain NULL values can be represented using nullable<none>.

Operations

db.add (::lingodb::compiler::dialect::db::AddOp)

Add int/float/decimal

Syntax:

operation ::= `db.add` $left `:` type($left) `,` $right `:` type($right) attr-dict

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, DB_NeedsNullWrap, DB_SupportsInvalidValues, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Operand	Description
left	any type or nullable
right	any type or nullable

Results:

Result	Description
result	any type

db.and (::lingodb::compiler::dialect::db::AndOp)

Logical And

Syntax:

operation ::= `db.and` $vals `:` type($vals) attr-dict

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface), SupportsNullabilityChange

Effects: MemoryEffects::Effect{}

Operands:

Operand	Description
vals	variadic of 1-bit signless integer or nullable

Results:

Result	Description
res	1-bit signless integer or nullable

db.arrow.append (::lingodb::compiler::dialect::db::AppendArrowOp)

Append value to arrow array

Syntax:

operation ::= `db.arrow.append` $builder `,` $value `->` type($value) attr-dict

Operands:

Operand	Description
builder	represents an anonymous Apache Arrow builder (building a chunked array), without knowledge of the type stored by it
value	any type or nullable

db.arrow.load (::lingodb::compiler::dialect::db::LoadArrowOp)

Loads value from arrow array

Syntax:

operation ::= `db.arrow.load` $array `,` $offset `->` type($res) attr-dict

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Operand	Description
array	represents an anonymous Apache Arrow array, without knowledge of the type stored by it
offset	index

Results:

Result	Description
res	any type or nullable

db.as_nullable (::lingodb::compiler::dialect::db::AsNullableOp)

Convert to nullable type

Syntax:

operation ::= `db.as_nullable` $val `:` type($val) ( `,` $null^ )?  `->` type($res) attr-dict

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Operand	Description
val	any type
null	1-bit signless integer

Results:

Result	Description
res	nullable

db.between (::lingodb::compiler::dialect::db::BetweenOp)

Whether value is between lower and upper

Syntax:

operation ::= `db.between` $val `:` type ($val) `between` $lower `:` type($lower) `,` $upper `:` type($upper) `,` `lowerInclusive` `:` $lowerInclusive `,` `upperInclusive` `:` $upperInclusive attr-dict

Determine whether a value is in a given range. This is preferred over (and also internally derived from) two comparisons to simplify optimizations depending on information about a value range.

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, DB_MaySupportInvalidValues, DB_NeedsNullWrap, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface), SupportsNullabilityChange

Effects: MemoryEffects::Effect{}

Attributes:

Attribute	MLIR Type	Description
lowerInclusive	::mlir::IntegerAttr	1-bit signless integer attribute
upperInclusive	::mlir::IntegerAttr	1-bit signless integer attribute

Operands:

Operand	Description
val	any type or nullable
lower	any type or nullable
upper	any type or nullable

Results:

Result	Description
res	1-bit signless integer or nullable

db.cast (::lingodb::compiler::dialect::db::CastOp)

Cast value to different type

Syntax:

operation ::= `db.cast` $val `:` type($val) `->` type($res) attr-dict

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, DB_MaySupportInvalidValues, DB_NeedsNullWrap, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Operand	Description
val	any type or nullable

Results:

Result	Description
res	any type or nullable

db.compare (::lingodb::compiler::dialect::db::CmpOp)

Compare int/Decimal/String

Syntax:

operation ::= `db.compare` $predicate $left `:` type($left) `,` $right `:` type($right) attr-dict

Traits: AlwaysSpeculatableImplTrait

Interfaces: CmpOpInterface, ConditionallySpeculatable, DB_MaySupportInvalidValues, DB_NeedsNullWrap, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface), SupportsNullabilityChange

Effects: MemoryEffects::Effect{}

Attributes:

Attribute	MLIR Type	Description
predicate	::lingodb::compiler::dialect::db::DBCmpPredicateAttr	allowed 64-bit signless integer cases: 0, 1, 2, 3, 4, 5, 6 eq: Enum case: eq (eq) neq: Enum case: neq (neq) lt: Enum case: lt (lt) lte: Enum case: lte (lte) gt: Enum case: gt (gt) gte: Enum case: gte (gte)

Operands:

Operand	Description
left	any type or nullable
right	any type or nullable

Results:

Result	Description
res	1-bit signless integer or nullable

db.constant (::lingodb::compiler::dialect::db::ConstantOp)

Create constant value

Syntax:

operation ::= `db.constant` `(` $value `)` `:` type($result) attr-dict

Traits: AlwaysSpeculatableImplTrait, ConstantLike

Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Attributes:

Attribute	MLIR Type	Description
value	::mlir::Attribute	any attribute

Results:

Result	Description
result	any type

db.create_dict (::lingodb::compiler::dialect::db::CreateDictOp)

Create dict

Syntax:

operation ::= `db.create_dict` $cmpKeyFn `->` type($dict) attr-dict

Attributes:

Attribute	MLIR Type	Description
cmpKeyFn	::mlir::SymbolRefAttr	symbol reference attribute

Results:

Result	Description
dict

db.create_list (::lingodb::compiler::dialect::db::CreateListOp)

Create list

Syntax:

operation ::= `db.create_list` type($list) attr-dict

Results:

Result	Description
list

db.derive_truth (::lingodb::compiler::dialect::db::DeriveTruth)

Get whether a value is true-ish

Syntax:

operation ::= `db.derive_truth` $val `:` type($val) attr-dict

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Operand	Description
val	any type

Results:

Result	Description
res	1-bit signless integer

db.dict_contains (::lingodb::compiler::dialect::db::DictContainsOp)

Check whether dict contains key

Syntax:

operation ::= `db.dict_contains` $dict `:` type($dict) `[` $key `:` type($key) `->` $hash `]` attr-dict

Interfaces: InferTypeOpInterface

Operands:

Operand	Description
dict
key	any type
hash	index

Results:

Result	Description
contains	1-bit signless integer

db.dict_get (::lingodb::compiler::dialect::db::DictGetOp)

Get value from dict

Syntax:

operation ::= `db.dict_get` $dict `:` type($dict) `[` $key `:` type($key) `->` $hash`]` `:` type($value) attr-dict

Operands:

Operand	Description
dict
key	any type
hash	index

Results:

Result	Description
value	any type

db.dict_get_iter (::lingodb::compiler::dialect::db::DictGetIter)

Get iterator over dict

Syntax:

operation ::= `db.dict_get_iter` $dict `:` type($dict) `->` type($iter) attr-dict

Operands:

Operand	Description
dict

Results:

Result	Description
iter	dict iterator

db.dict_iter_get_key (::lingodb::compiler::dialect::db::DictIterGetKey)

Get key from dict iterator

Syntax:

operation ::= `db.dict_iter_get_key` $iter `:` type($iter) `->` type($key) attr-dict

Operands:

Operand	Description
iter	dict iterator

Results:

Result	Description
key	any type

db.dict_iter_get_value (::lingodb::compiler::dialect::db::DictIterGetValue)

Get value from dict iterator

Syntax:

operation ::= `db.dict_iter_get_value` $iter `:` type($iter) `->` type($value) attr-dict

Operands:

Operand	Description
iter	dict iterator

Results:

Result	Description
value	any type

db.dict_iter_next (::lingodb::compiler::dialect::db::DictIterNext)

Move to next element in dict iterator

Syntax:

operation ::= `db.dict_iter_next` $iter `:` type($iter) attr-dict

Operands:

Operand	Description
iter	dict iterator

db.dict_iter_valid (::lingodb::compiler::dialect::db::DictIterValid)

Check whether dict iterator is valid

Syntax:

operation ::= `db.dict_iter_valid` $iter `:` type($iter) attr-dict

Interfaces: InferTypeOpInterface

Operands:

Operand	Description
iter	dict iterator

Results:

Result	Description
isValid	1-bit signless integer

db.dict_length (::lingodb::compiler::dialect::db::DictLengthOp)

Get length of dict

Syntax:

operation ::= `db.dict_length` $dict `:` type($dict) attr-dict

Interfaces: InferTypeOpInterface

Operands:

Operand	Description
dict

Results:

Result	Description
length	index

db.dict_set (::lingodb::compiler::dialect::db::DictSetOp)

Set value in dict

Syntax:

operation ::= `db.dict_set` $dict `:` type($dict) `[` $key `:` type($key)  `->` $hash `]` `=` $value `:` type($value) attr-dict

Operands:

Operand	Description
dict
key	any type
hash	index
value	any type

db.div (::lingodb::compiler::dialect::db::DivOp)

Divide int/float/decimal

Syntax:

operation ::= `db.div` $left `:` type($left) `,` $right `:` type($right) attr-dict

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, DB_NeedsNullWrap, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Operand	Description
left	any type or nullable
right	any type or nullable

Results:

Result	Description
result	any type

db.hash (::lingodb::compiler::dialect::db::Hash)

Compute hash

Syntax:

operation ::= `db.hash` $val `:` type($val) attr-dict

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Operand	Description
val	variadic of any type

Results:

Result	Description
hash	index

db.isnull (::lingodb::compiler::dialect::db::IsNullOp)

Indicate whether a nullable value is null

Syntax:

operation ::= `db.isnull` $val `:` type($val) attr-dict

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Operand	Description
val	nullable

Results:

Result	Description
result	1-bit signless integer

db.list_append (::lingodb::compiler::dialect::db::ListAppendOp)

Append element to list

Syntax:

operation ::= `db.list_append` $list `:` type($list)  `,` $element `:` type($element) attr-dict

Operands:

Operand	Description
list
element	any type

db.list_get (::lingodb::compiler::dialect::db::ListGetOp)

Get element from list

Syntax:

operation ::= `db.list_get` $list `:` type($list) `[` $index `]` `:` type($element) attr-dict

Operands:

Operand	Description
list
index	index

Results:

Result	Description
element	any type

db.list_length (::lingodb::compiler::dialect::db::ListLengthOp)

Get length of list

Syntax:

operation ::= `db.list_length` $list `:` type($list) attr-dict

Interfaces: InferTypeOpInterface

Operands:

Operand	Description
list

Results:

Result	Description
length	index

db.list_set (::lingodb::compiler::dialect::db::ListSetOp)

Set element in list

Syntax:

operation ::= `db.list_set` $list `:` type($list) `[` $index `]` `=` $element `:` type($element) attr-dict

Operands:

Operand	Description
list
index	index
element	any type

db.mod (::lingodb::compiler::dialect::db::ModOp)

Remainder of int/float/decimal

Syntax:

operation ::= `db.mod` $left `:` type($left) `,` $right `:` type($right) attr-dict

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, DB_NeedsNullWrap, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Operand	Description
left	any type or nullable
right	any type or nullable

Results:

Result	Description
result	any type

db.mul (::lingodb::compiler::dialect::db::MulOp)

Multiply int/float/decimal

Syntax:

operation ::= `db.mul` $left `:` type($left) `,` $right `:` type($right) attr-dict

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, DB_NeedsNullWrap, DB_SupportsInvalidValues, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Operand	Description
left	any type or nullable
right	any type or nullable

Results:

Result	Description
result	any type

db.not (::lingodb::compiler::dialect::db::NotOp)

Logical Not

Syntax:

operation ::= `db.not` $val `:` type($val) attr-dict

Traits: AlwaysSpeculatableImplTrait, SameOperandsAndResultType

Interfaces: ConditionallySpeculatable, DB_NeedsNullWrap, DB_SupportsInvalidValues, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Operand	Description
val	1-bit signless integer or nullable

Results:

Result	Description
res	1-bit signless integer or nullable

db.null (::lingodb::compiler::dialect::db::NullOp)

Create null value

Syntax:

operation ::= `db.null` `:` type($res) attr-dict

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Results:

Result	Description
res	nullable

db.nullable_get_val (::lingodb::compiler::dialect::db::NullableGetVal)

Get value of nullable type

Syntax:

operation ::= `db.nullable_get_val` $val `:` type($val)  attr-dict

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Operand	Description
val	nullable

Results:

Result	Description
res	any type

db.oneof (::lingodb::compiler::dialect::db::OneOfOp)

Whether val is included in vals

Syntax:

operation ::= `db.oneof` $val `:` type ($val) `?` $vals `:` type ($vals) attr-dict

Determine whether val is included in vals; similar to IN in SQL.

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, DB_NeedsNullWrap, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface), SupportsNullabilityChange

Effects: MemoryEffects::Effect{}

Operands:

Operand	Description
val	any type or nullable
vals	variadic of any type or nullable

Results:

Result	Description
res	1-bit signless integer or nullable

db.or (::lingodb::compiler::dialect::db::OrOp)

Logical Or

Syntax:

operation ::= `db.or` $vals `:` type($vals) attr-dict

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface), SupportsNullabilityChange

Effects: MemoryEffects::Effect{}

Operands:

Operand	Description
vals	variadic of any type

Results:

Result	Description
res	1-bit signless integer or nullable

db.runtime_call (::lingodb::compiler::dialect::db::RuntimeCall)

Call runtime function

Syntax:

operation ::= `db.runtime_call` $fn  `(` $args `)` `:`  functional-type($args,$res)  attr-dict

Interfaces: DB_MayNeedNullWrap, DB_MaySupportInvalidValues

Attributes:

Attribute	MLIR Type	Description
fn	::mlir::StringAttr	string attribute

Operands:

Operand	Description
args	variadic of any type

Results:

Result	Description
res	any type

db.sort_compare (::lingodb::compiler::dialect::db::SortCompare)

Get whether a value is true-ish

Syntax:

operation ::= `db.sort_compare` $left `:` type($left) `,` $right `:` type($right) attr-dict

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Operand	Description
left	any type
right	any type

Results:

Result	Description
res	8-bit signless integer

db.sub (::lingodb::compiler::dialect::db::SubOp)

Subtract int/float/decimal

Syntax:

operation ::= `db.sub` $left `:` type($left) `,` $right `:` type($right) attr-dict

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, DB_NeedsNullWrap, DB_SupportsInvalidValues, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Operand	Description
left	any type or nullable
right	any type or nullable

Results:

Result	Description
result	any type

Types

CharType

char

Syntax:

!db.char<
  unsigned   # len
>

Fixed-size array of chars.

Parameters:

Parameter	C++ type	Description
len	unsigned

DateType

date

Syntax:

!db.date<
  DateUnitAttr   # unit
>

Parameters:

Parameter	C++ type	Description
unit	DateUnitAttr

DecimalType

decimal

Syntax:

!db.decimal<
  int,   # p
  int   # s
>

Decimal type with p digits in total and s digits after the decimal point.

Parameters:

Parameter	C++ type	Description
p	int
s	int

IntervalType

interval

Syntax:

!db.interval<
  IntervalUnitAttr   # unit
>

Parameters:

Parameter	C++ type	Description
unit	IntervalUnitAttr

StringType

string

Syntax: !db.string

Variable-length string.

TimestampType

timestamp

Syntax:

!db.timestamp<
  TimeUnitAttr   # unit
>

Parameters:

Parameter	C++ type	Description
unit	TimeUnitAttr

DictIterType

dict iterator

Syntax:

!db.dict_iter<
  mlir::Type,   # keyType
  mlir::Type   # valueType
>

Iterator over a dict, yielding key-value pairs.

Parameters:

Parameter	C++ type	Description
keyType	mlir::Type
valueType	mlir::Type

DictType

Syntax:

!db.dict<
  mlir::Type,   # keyType
  mlir::Type   # valueType
>

Parameters:

Parameter	C++ type	Description
keyType	mlir::Type
valueType	mlir::Type

ListType

Syntax:

!db.list<
  mlir::Type   # elementType
>

Parameters:

Parameter	C++ type	Description
elementType	mlir::Type

NullableType

nullable

Syntax:

!db.nullable<
  mlir::Type   # type
>

Parameters:

Parameter	C++ type	Description
type	mlir::Type

Enums

DBCmpPredicate

allowed 64-bit signless integer cases: 0, 1, 2, 3, 4, 5, 6

Cases:

Symbol	Value	String
eq	0	eq
neq	1	neq
lt	2	lt
lte	3	lte
gt	4	gt
gte	5	gte
isa	6	isa

DateUnitAttr

allowed 64-bit signless integer cases: 0, 1

Cases:

Symbol	Value	String
day	0	day
millisecond	1	millisecond

IntervalUnitAttr

allowed 64-bit signless integer cases: 0, 1

Cases:

Symbol	Value	String
months	0	months
daytime	1	daytime

TimeUnitAttr

allowed 64-bit signless integer cases: 0, 1, 2, 3

Cases:

Symbol	Value	String
second	0	second
millisecond	1	millisecond
microsecond	2	microsecond
nanosecond	3	nanosecond