README
U
Column
U
ColumnType
U
DbResult
U
ForeignKey
U
Index
U
IndexType
U
OrderBy
U
Set
U
Table
U
Where
U
WhereType
Tr
Driver
Tr
Entity
- ::equalAssociation::equal
- ::from_jsonAssociation::from_json
- ::not_equalAssociation::not_equal
- ::outputAssociation::output
- ::to_jsonAssociation::to_json
- ::to_stringAssociation::to_string
- ::equalAssociationKind::equal
- ::from_jsonAssociationKind::from_json
- ::not_equalAssociationKind::not_equal
- ::outputAssociationKind::output
- ::to_jsonAssociationKind::to_json
- ::to_stringAssociationKind::to_string
- ::equalColumnDiff::equal
- ::not_equalColumnDiff::not_equal
- ::outputColumnDiff::output
- ::to_jsonColumnDiff::to_json
- ::to_stringColumnDiff::to_string
- ::outputDbError::output
- ::to_jsonDbError::to_json
- ::to_stringDbError::to_string
- ::equalDeleteQuery::equal
- ::fromDeleteQuery::from
- ::from_jsonDeleteQuery::from_json
- ::not_equalDeleteQuery::not_equal
- ::outputDeleteQuery::output
- ::to_jsonDeleteQuery::to_json
- ::to_queryDeleteQuery::to_query
- ::to_stringDeleteQuery::to_string
- ::where_eqDeleteQuery::where_eq
- ::where_gtDeleteQuery::where_gt
- ::where_gteDeleteQuery::where_gte
- ::where_likeDeleteQuery::where_like
- ::where_ltDeleteQuery::where_lt
- ::where_lteDeleteQuery::where_lte
- ::where_neDeleteQuery::where_ne
- ::equalForeignKeyDiff::equal
- ::from_jsonForeignKeyDiff::from_json
- ::not_equalForeignKeyDiff::not_equal
- ::outputForeignKeyDiff::output
- ::to_jsonForeignKeyDiff::to_json
- ::to_stringForeignKeyDiff::to_string
- ::equalIndexDiff::equal
- ::from_jsonIndexDiff::from_json
- ::not_equalIndexDiff::not_equal
- ::outputIndexDiff::output
- ::to_jsonIndexDiff::to_json
- ::to_stringIndexDiff::to_string
- ::columnsInsertQuery::columns
- ::equalInsertQuery::equal
- ::fromInsertQuery::from
- ::from_jsonInsertQuery::from_json
- ::from_manyInsertQuery::from_many
- ::not_equalInsertQuery::not_equal
- ::outputInsertQuery::output
- ::to_jsonInsertQuery::to_json
- ::to_queryInsertQuery::to_query
- ::to_stringInsertQuery::to_string
- ::valuesInsertQuery::values
- ::values_manyInsertQuery::values_many
T
PreloadResult
- ::equalQuery::equal
- ::from_jsonQuery::from_json
- ::joinQuery::join
- ::limitQuery::limit
- ::not_equalQuery::not_equal
- ::offsetQuery::offset
- ::order_byQuery::order_by
- ::outputQuery::output
- ::to_count_sqlQuery::to_count_sql
- ::to_jsonQuery::to_json
- ::to_queryQuery::to_query
- ::to_stringQuery::to_string
- ::where_eqQuery::where_eq
- ::where_gtQuery::where_gt
- ::where_gteQuery::where_gte
- ::where_likeQuery::where_like
- ::where_ltQuery::where_lt
- ::where_lteQuery::where_lte
- ::where_neQuery::where_ne
- ::equalTableDiff::equal
- ::not_equalTableDiff::not_equal
- ::outputTableDiff::output
- ::to_jsonTableDiff::to_json
- ::to_stringTableDiff::to_string
- ::commitTxBatch::commit
- ::execTxBatch::exec
- ::rollbackTxBatch::rollback
- ::rollback_to_savepointTxBatch::rollback_to_savepoint
- ::savepointTxBatch::savepoint
- ::equalTxQuery::equal
- ::from_jsonTxQuery::from_json
- ::not_equalTxQuery::not_equal
- ::outputTxQuery::output
- ::to_jsonTxQuery::to_json
- ::to_queryTxQuery::to_query
- ::to_stringTxQuery::to_string
- ::equalUpdateQuery::equal
- ::fromUpdateQuery::from
- ::from_jsonUpdateQuery::from_json
- ::not_equalUpdateQuery::not_equal
- ::outputUpdateQuery::output
- ::setUpdateQuery::set
- ::to_jsonUpdateQuery::to_json
- ::to_queryUpdateQuery::to_query
- ::to_stringUpdateQuery::to_string
- ::where_eqUpdateQuery::where_eq
- ::where_gtUpdateQuery::where_gt
- ::where_gteUpdateQuery::where_gte
- ::where_likeUpdateQuery::where_like
- ::where_ltUpdateQuery::where_lt
- ::where_lteUpdateQuery::where_lte
- ::where_neUpdateQuery::where_ne
- ::do_update_setUpsertQuery::do_update_set
- ::equalUpsertQuery::equal
- ::fromUpsertQuery::from
- ::from_jsonUpsertQuery::from_json
- ::not_equalUpsertQuery::not_equal
- ::on_conflictUpsertQuery::on_conflict
- ::outputUpsertQuery::output
- ::setUpsertQuery::set
- ::to_jsonUpsertQuery::to_json
- ::to_queryUpsertQuery::to_query
- ::to_stringUpsertQuery::to_string
V
add_column
V
add_column_engine_option
V
add_foreign_key
V
add_index
V
add_table_engine_option
V
after_create
V
after_delete
V
after_find
V
after_update
V
asc
V
auto_migrate
V
before_create
V
before_delete
V
before_update
V
belongs_to
V
current_plain_date_time_utc
V
current_timestamp_utc
V
delete_from
V
desc
V
diff_table
V
has_many
V
has_one
V
infer_column_type
V
insert_into
V
many_to_many
V
mysql_table_compression
V
mysql_table_key_block_size
V
mysql_table_row_format
V
new_column
V
new_foreign_key
V
new_index
V
new_primary_index
V
new_table
V
new_unique_index
V
on_delete_cascade
V
on_update_cascade
V
oracle_table_on_commit
V
oracle_table_organization
V
page
V
pageable
V
pageable_with_sort
V
paginate
V
paginate_raw
V
pg_default_sequence_grant
V
pg_default_table_grant
V
pg_schema_authorization
V
pg_schema_grant
V
pg_schema_sequence_grant
V
pg_sequence_grant
V
pg_table_grant
V
pg_table_on_commit
V
pg_table_owner
V
pg_table_unlogged
V
pg_table_with
V
preload
V
preload_belongs_to
V
preload_has_many
V
preload_has_one
V
preload_many_to_many
V
register_driver_scheme
V
resolve_driver_name
V
restore_by_id
V
select_from
V
select_from_scoped
V
select_raw
V
soft_delete_by_id
V
sort
V
sqlite_table_strict
V
sqlite_table_without_rowid
V
sqlserver_table_durability
V
sqlserver_table_filegroup
V
sqlserver_table_memory_optimized
V
sqlserver_table_textimage_on
V
table_catalog
V
table_comment
V
table_create_suffix
V
table_engine
V
table_has_primary_key
V
table_if_not_exists
V
table_primary_key
V
table_schema
V
table_tablespace
V
table_temporary
V
tx_begin
V
tx_block
V
tx_commit
V
tx_rollback
V
tx_rollback_to_savepoint
V
tx_savepoint
V
unregister_driver_scheme
V
update
V
upsert_into

morm

A lightweight MoonBit ORM with typed queries, code generation, and multi-database engines

orm

database

sql

query builder

code generation

moonbit

Download zip

Author

oboard

Version

0.5.0

License

Apache-2.0

Repository

github.com/oboard/morm

Last updated

7 days ago

Downloads

636

Dependencies

#oboard/morm

morm is a lightweight ORM toolkit for MoonBit.

It is built around a simple split:

entities describe schema
mormgen generates plain MoonBit code
query builders describe SQL intent
engines render and execute real database behavior

The project deliberately avoids runtime reflection and hidden ORM state.

#What It Covers

morm provides:

entity-to-table metadata generation with #morm.entity
mapper generation from annotated traits
typed query builders for select, insert, upsert, update, and delete
page-based pagination helpers with sortable Pageable (paginate / paginate_raw)
multi-engine support through a shared Engine contract
native DuckDB support through an embedded binding for analytics
local time-type support for PlainDate, PlainTime, PlainDateTime, and ZonedDateTime
direct MoonBit enum support in generated ToParam / FromParam impls and schema metadata
generated auto timestamp handling for created_at / updated_at and explicit timestamp annotations
transient entity fields via #morm.transient (kept in model, excluded from physical columns and from(entity) writes)
PostgreSQL schema ownership and grant support via #morm.postgres.schema, #morm.postgres.table, and #morm.postgres.grant

#Install

Add the package to your application's moon.mod.json:

{
  "bin-deps": {
    "oboard/morm": "latest"
  }
}

#Generate Code

A typical package imports morm and the generated-code dependencies with the aliases that mormgen emits:

import {
  "oboard/morm",
  "oboard/morm/engine" @morm/engine,
}

Add engine packages such as "oboard/morm/engine/sqlite3" as needed by your hand-written runtime code. For DuckDB, import "oboard/morm/engine/duckdb" and install the native libduckdb library; see the DuckDB guide.

This is a breaking generated-code alias change. If your package still imports "oboard/morm/engine" as the old implicit @engine alias, update the alias before regenerating code.

A typical package uses pre-build to generate .g.mbt files:

options(
  "pre-build": [
    {
      "command": "$mod_dir/.mooncakes/oboard/morm/morm-gen $input -o $output && moonfmt -w $output",
      "input": "entities.mbt",
      "output": "entities.g.mbt",
    },
    {
      "command": "$mod_dir/.mooncakes/oboard/morm/morm-gen $input -o $output && moonfmt -w $output",
      "input": "mapper.mbt",
      "output": "mapper.g.mbt",
    },
  ],
)

#Entity Example

///|
using @time {type PlainDateTime}

///|
#mormentity
pub(all) struct Class {
  #mormid
  #mormdefault(autoincrement())
  id : Int64

  #mormvarchar(length="255")
  name : String

  created_at : PlainDateTime
  updated_at : PlainDateTime
} derive(ToJson, FromJson)

Payload-free MoonBit enums can also be used directly as entity fields. mormgen will generate enum codecs and emit native enum DDL for engines that support it (currently MySQL and PostgreSQL).

#Mapper Example

///|
#mormmapper(table="class")
pub trait ClassMapper {
  async save(Self, entity : Class) -> Class
}

///|
#mormmapper(table="student")
pub trait StudentMapper {
  async find_student_by_id(Self, id : Int) -> Student?
  async find_student_by_name(Self, name : String) -> Student?
  async find_students_by_age(Self, age : Int) -> FixedArray[Student]
}

Generated save methods can assign:

created_at
updated_at
fields marked with #morm.auto_create_time
fields marked with #morm.auto_update_time

PlainDateTime fields use @morm.current_plain_date_time_utc(), and ZonedDateTime fields use @morm.current_timestamp_utc().

#Query Builder Example

let q = @morm.select_from("class")
  .where_eq("id", 1)
  .order_by(@morm.desc("id"))
  .limit(1)

Execute through an engine:

let res = engine.exec(q)

#Pagination Example

morm pagination is 1-based (page=1 is the first page):

let pageable = @morm.pageable_with_sort(1, 20, @morm.desc("id"))

let q = @morm.select_from("student")
  .where_gte("age", 18)

let page = @morm.paginate(
  engine,
  q,
  pageable,
)

For raw SQL:

let page = @morm.paginate_raw(
  engine,
  "SELECT id, name, age FROM student WHERE age >= ?",
  [18],
  @morm.pageable(2, 10),
)

#Migration Example

@morm.auto_migrate(engine, [Class::table()])

Migration execution stays engine-specific by design.

#Documentation

See the VitePress docs in docs/:

morm

#oboard/morm

#What It Covers

#Install

#Generate Code

#Entity Example

#Mapper Example

#Query Builder Example

#Pagination Example

#Migration Example

#Documentation

#Column

#ColumnType

#DbResult

#ForeignKey

#Index

#IndexType

#OrderBy

#Set

#Table

#Where

#WhereType

#Driver

#Entity

#Association

#Association::equal

#Association::from_json

#Association::not_equal

#Association::output

#Association::to_json

#Association::to_string

#AssociationKind

#AssociationKind::equal

#AssociationKind::from_json

#AssociationKind::not_equal

#AssociationKind::output

#AssociationKind::to_json

#AssociationKind::to_string

#ColumnDiff

#ColumnDiff::equal

#ColumnDiff::not_equal

#ColumnDiff::output

#ColumnDiff::to_json

#ColumnDiff::to_string

#DbError

#DbError::output

#DbError::to_json

#DbError::to_string

#DeleteQuery

#DeleteQuery::equal

#DeleteQuery::from

#DeleteQuery::from_json

#DeleteQuery::not_equal

#DeleteQuery::output

#DeleteQuery::to_json

#DeleteQuery::to_query

#DeleteQuery::to_string

#DeleteQuery::where_eq

#DeleteQuery::where_gt

#DeleteQuery::where_gte

#DeleteQuery::where_like

#DeleteQuery::where_lt

#DeleteQuery::where_lte

#DeleteQuery::where_ne

#ForeignKeyDiff

#ForeignKeyDiff::equal

#ForeignKeyDiff::from_json

#ForeignKeyDiff::not_equal

#ForeignKeyDiff::output

#ForeignKeyDiff::to_json

#ForeignKeyDiff::to_string

#IndexDiff

#IndexDiff::equal

#IndexDiff::from_json

#IndexDiff::not_equal

#IndexDiff::output

#IndexDiff::to_json

#IndexDiff::to_string

#InsertQuery

#InsertQuery::columns

Column

ColumnType

DbResult

ForeignKey

Index

IndexType

OrderBy

Set

Table

Where

WhereType

Driver

Entity

Association

Association::equal

Association::from_json

Association::not_equal

Association::output

Association::to_json

Association::to_string

AssociationKind

AssociationKind::equal

AssociationKind::from_json

AssociationKind::not_equal

AssociationKind::output

AssociationKind::to_json

AssociationKind::to_string

ColumnDiff

ColumnDiff::equal

ColumnDiff::not_equal

ColumnDiff::output

ColumnDiff::to_json

ColumnDiff::to_string

DbError

DbError::output

DbError::to_json

DbError::to_string

DeleteQuery

DeleteQuery::equal

DeleteQuery::from

DeleteQuery::from_json

DeleteQuery::not_equal

DeleteQuery::output

DeleteQuery::to_json

DeleteQuery::to_query

DeleteQuery::to_string

DeleteQuery::where_eq

DeleteQuery::where_gt

DeleteQuery::where_gte

DeleteQuery::where_like

DeleteQuery::where_lt

DeleteQuery::where_lte

DeleteQuery::where_ne

ForeignKeyDiff

ForeignKeyDiff::equal

ForeignKeyDiff::from_json

ForeignKeyDiff::not_equal

ForeignKeyDiff::output

ForeignKeyDiff::to_json

ForeignKeyDiff::to_string

IndexDiff

IndexDiff::equal

IndexDiff::from_json

IndexDiff::not_equal

IndexDiff::output

IndexDiff::to_json

IndexDiff::to_string

InsertQuery

InsertQuery::columns

InsertQuery::equal

InsertQuery::from

InsertQuery::from_json

InsertQuery::from_many

InsertQuery::not_equal

InsertQuery::output

InsertQuery::to_json

InsertQuery::to_query

InsertQuery::to_string

InsertQuery::values

InsertQuery::values_many