Allianaab2m/aya/kit - mooncakes.io

README
U
Row
Tr
Driver
Tr
Executor
Tr
SqlDecode
Tr
SqlEncode
Tr
SqlNum
Tr
SqlOrd
E
DbError
E
DecodeError
E
StatementError
T
BinOp
- ::contramapBinding::contramap
- ::newBinding::new
- ::withoutBinding::without
- ::ascColumn::asc
- ::descColumn::desc
- ::eqColumn::eq
- ::eq_colColumn::eq_col
- ::exprColumn::expr
- ::gtColumn::gt
- ::gteColumn::gte
- ::in_Column::in_
- ::is_noneColumn::is_none
- ::is_someColumn::is_some
- ::ltColumn::lt
- ::lteColumn::lte
- ::neColumn::ne
- ::newColumn::new
- ::nullableColumn::nullable
- ::rawColumn::raw
- ::filterDelete::filter
- ::runDelete::run
- ::to_sqlDelete::to_sql
T
Dialect
T
Dir
- ::exprEmitter::expr
- ::newEmitter::new
- ::ascExpr::asc
- ::descExpr::desc
- ::eqExpr::eq
- ::eq_colExpr::eq_col
- ::gtExpr::gt
- ::gteExpr::gte
- ::in_Expr::in_
- ::is_noneExpr::is_none
- ::is_someExpr::is_some
- ::ltExpr::lt
- ::lteExpr::lte
- ::neExpr::ne
- ::rawExpr::raw
- ::runInsert::run
- ::to_sqlInsert::to_sql
T
Join
T
JoinKind
- ::colNullable::col
- ::rowNullable::row
T
OrderKey
- ::filterQuery::filter
- ::firstQuery::first
- ::group_byQuery::group_by
- ::joinQuery::join
- ::left_joinQuery::left_join
- ::limitQuery::limit
- ::mapQuery::map
- ::map_colsQuery::map_cols
- ::oneQuery::one
- ::order_byQuery::order_by
- ::reduceQuery::reduce
- ::runQuery::run
- ::to_sqlQuery::to_sql
T
RawExpr
- ::mapReducer::map
- ::zipReducer::zip
- ::into2Selection::into2
- ::into3Selection::into3
- ::mapSelection::map
- ::newSelection::new
- ::optionalSelection::optional
- ::optional_onSelection::optional_on
- ::zipSelection::zip
T
SqlValue
- ::newTable::new
- ::driverTx::driver
- ::is_openTx::is_open
- ::newTx::new
- ::filterUpdate::filter
- ::runUpdate::run
- ::setUpdate::set
- ::to_sqlUpdate::to_sql
V
avg
V
count
V
count_of
V
delete
V
delete_all
V
from
V
insert
V
insert_except
V
insert_many
V
max
V
min
V
sel
V
sel2
V
sel3
V
split2
V
sum
V
transaction
V
update
V
update_all

Allianaab2m/aya/kit does not have a README file

KitError

pub(all) suberror KitError {
  BadConfig(reason~ : String)
  BadJournal(reason~ : String)
  DialectMismatch(journal~ : String, config~ : String)
} derive(@moonbitlang/core/debug.Debug
Debug)

impl Show for KitError

Config

source

pub(all) struct Config {
  dialect : @Allianaab2m/aya.Dialect
Dialect
  schema : Array[String]
  out : String
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Where the project keeps its schema and its migrations.

A file rather than flags, for the same reason drizzle has one: every command needs the same three answers, and a repository should not depend on each developer typing them the same way.

Config::from_json_string

source

fn Config::from_json_string(text : String) -> Config raise KitError

Read a config file.

Every key is optional: a project that only overrides schema should not have to restate the defaults.

Config::journal_path

source

fn Config::journal_path(self : Config) -> String

Config::meta_dir

source

fn Config::meta_dir(self : Config) -> String

Config::migration_path

source

fn Config::migration_path(self : Config, tag : String) -> String

Config::new

source

fn Config::new() -> Config

What a project gets without a config file.

Config::snapshot_path

source

fn Config::snapshot_path(self : Config, idx : Int) -> String

Config::to_json_string

source

fn Config::to_json_string(self : Config) -> String

Render a config file, for aya-kit init.

Journal

source

pub(all) struct Journal {
  version : String
  dialect : @Allianaab2m/aya.Dialect
Dialect
  entries : Array[JournalEntry]
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

The index of the migrations directory.

The directory listing cannot be the index: file names sort lexically, tell you nothing about which dialect they were written for, and say nothing when one is deleted by hand.

Journal::from_json_string

source

fn Journal::from_json_string(text : String) -> Journal raise KitError

Journal::last

source

fn Journal::last(self : Journal) -> JournalEntry?

The last migration generated, if any.

Journal::new

source

fn Journal::new(dialect : @Allianaab2m/aya.Dialect
Dialect) -> Journal

Journal::next_index

source

fn Journal::next_index(self : Journal) -> Int

The index the next migration will take.

Journal::to_json_string

source

fn Journal::to_json_string(self : Journal) -> String

JournalEntry

source

pub(all) struct JournalEntry {
  idx : Int
  tag : String
  when_ : Int64
  breakpoints : Bool
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

One migration that has been generated, in the order it must run.

Migration

source

pub struct Migration {
  idx : Int
  tag : String
  sql : String
  snapshot : String
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

A migration, as the three files it becomes.

Produced without touching the filesystem so that the interesting part — what SQL a schema edit turns into — is testable, and so a failure part-way through cannot leave a .sql on disk with no snapshot beside it.

Plan

source

pub struct Plan {
  changes : Array[@Allianaab2m/aya/ddl.Change
Change]
  migration : Migration?
  journal : Journal
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

What generate would do.

CONFIG_FILE

source

let CONFIG_FILE : String

The name looked for when --config is not given.

JOURNAL_VERSION

source

let JOURNAL_VERSION : String

describe

source

fn describe(changes : Array[@Allianaab2m/aya/ddl.Change
Change]) -> String

A short report of what a plan would change, one line per change.

pad_index

source

fn pad_index(idx : Int) -> String

A four-digit migration index: 12 -> 0012.

Fixed width so the directory sorts the way the migrations run, which is the order anyone reading it will assume anyway.

plan

source

fn plan(journal~ : Journal, previous~ : @Allianaab2m/aya/ddl.Snapshot
Snapshot, next~ : @Allianaab2m/aya/ddl.Snapshot
Snapshot, now~ : Int64, name? : String) -> Plan raise

Work out the next migration from the two snapshots around it.

name overrides the generated slug; without one the migration is named after its first change, so the migrations directory reads as a changelog.

snapshot_of_sources

source

fn snapshot_of_sources(sources : Array[(String, String)], dialect~ : @Allianaab2m/aya.Dialect
Dialect) -> @Allianaab2m/aya/ddl.Snapshot
Snapshot raise

Parse every schema source and lower them all into one snapshot.

Sources are (name, contents) pairs; the name only ever shows up in a parse error, so the caller decides whether that is a path or something else.

Source Files

Install

Download zip

A thin, type-safe SQL toolkit for MoonBit

Allianaab2m

Apache-2.0

github.com/Allianaab2m/aya-orm

Updated 2 months ago

220 downloads

Site source Report issue Modules Skills CLI Build queue Statistics

#KitError

#Config

#Config::from_json_string

#Config::journal_path

#Config::meta_dir

#Config::migration_path

#Config::new

#Config::snapshot_path

#Config::to_json_string

#Journal

#Journal::from_json_string

#Journal::last

#Journal::new

#Journal::next_index

#Journal::to_json_string

#JournalEntry

#Migration

#Plan

#CONFIG_FILE

#JOURNAL_VERSION

#describe

#pad_index

#plan

#snapshot_of_sources

Source Files

KitError

Config

Config::from_json_string

Config::journal_path

Config::meta_dir

Config::migration_path

Config::new

Config::snapshot_path

Config::to_json_string

Journal

Journal::from_json_string

Journal::last

Journal::new

Journal::next_index

Journal::to_json_string

JournalEntry

Migration

Plan

CONFIG_FILE

JOURNAL_VERSION

describe

pad_index

plan

snapshot_of_sources