jaredzhou/foxql/builder

jaredzhou/foxql/builder does not have a README file

AnyColumn

pub trait AnyColumn {
  fn name(Self) -> String
  fn table_name(Self) -> String
  fn sql_type(Self) -> @jaredzhou/foxql/ast.SqlType
SqlType
}

Trait that erases T — exposes column identity for heterogeneous column lists.

impl AnyColumn for ColumnRef

fn name(self : @jaredzhou/foxql/ast.ColumnRef
ColumnRef) -> String

source

fn sql_type(_self : @jaredzhou/foxql/ast.ColumnRef
ColumnRef) -> @jaredzhou/foxql/ast.SqlType
SqlType

source

fn table_name(self : @jaredzhou/foxql/ast.ColumnRef
ColumnRef) -> String

source

Comparable

source

pub trait Comparable {
  fn to_sql_type(Self) -> @jaredzhou/foxql/ast.SqlType
SqlType
}

Trait for types that support comparison operators (gt, gte, lt, lte, between).

impl Comparable for Int

impl Comparable for Double

StringMatchable

source

pub trait StringMatchable {
  fn to_sql_type(Self) -> @jaredzhou/foxql/ast.SqlType
SqlType
}

Trait for types that support string operators (like, not_like).

impl StringMatchable for String

Column

source

pub(all) struct Column[T] {
  name : String
  table : String
  sql_type : @jaredzhou/foxql/ast.SqlType
SqlType
  _marker : T?
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

A typed column reference in a specific table.

impl AnyColumn for Column[T]

Column::asc

source

fn[T] Column::asc(self : Column[T]) -> @jaredzhou/foxql/ast.OrderByClause
OrderByClause

Sort ascending.

Column::between

source

fn[T : Comparable + @jaredzhou/foxql/ast.ToValue
ToValue] Column::between(self : Column[T], lo : T, hi : T) -> @jaredzhou/foxql/ast.Expr
Expr

Column::desc

source

fn[T] Column::desc(self : Column[T]) -> @jaredzhou/foxql/ast.OrderByClause
OrderByClause

Sort descending.

Column::eq

source

fn[T : @jaredzhou/foxql/ast.ToValue
ToValue] Column::eq(self : Column[T], value : T) -> @jaredzhou/foxql/ast.Expr
Expr

Column::eq_col

source

fn[T] Column::eq_col(self : Column[T], other : Column[T]) -> @jaredzhou/foxql/ast.Expr
Expr

Compare two columns for equality (for JOIN ON).

Column::eq_select

source

fn[T] Column::eq_select(self : Column[T], subquery : @jaredzhou/foxql/ast.SelectStmt
SelectStmt) -> @jaredzhou/foxql/ast.Expr
Expr

Compare column with a scalar subquery.

Column::gt

source

fn[T : Comparable + @jaredzhou/foxql/ast.ToValue
ToValue] Column::gt(self : Column[T], value : T) -> @jaredzhou/foxql/ast.Expr
Expr

Column::gt_select

source

fn[T] Column::gt_select(self : Column[T], subquery : @jaredzhou/foxql/ast.SelectStmt
SelectStmt) -> @jaredzhou/foxql/ast.Expr
Expr

Column::gte

source

fn[T : Comparable + @jaredzhou/foxql/ast.ToValue
ToValue] Column::gte(self : Column[T], value : T) -> @jaredzhou/foxql/ast.Expr
Expr

Column::gte_select

source

fn[T] Column::gte_select(self : Column[T], subquery : @jaredzhou/foxql/ast.SelectStmt
SelectStmt) -> @jaredzhou/foxql/ast.Expr
Expr

Column::in_

source

fn[T : @jaredzhou/foxql/ast.ToValue
ToValue] Column::in_(self : Column[T], vals : Array[T]) -> @jaredzhou/foxql/ast.Expr
Expr

Column::in_select

source

fn[T] Column::in_select(self : Column[T], subquery : @jaredzhou/foxql/ast.SelectStmt
SelectStmt) -> @jaredzhou/foxql/ast.Expr
Expr

Column::is_not_null

source

fn[T] Column::is_not_null(self : Column[T]) -> @jaredzhou/foxql/ast.Expr
Expr

Column::is_null

source

fn[T] Column::is_null(self : Column[T]) -> @jaredzhou/foxql/ast.Expr
Expr

Column::like

source

fn[T : StringMatchable] Column::like(self : Column[T], pattern : String) -> @jaredzhou/foxql/ast.Expr
Expr

Column::lt

source

fn[T : Comparable + @jaredzhou/foxql/ast.ToValue
ToValue] Column::lt(self : Column[T], value : T) -> @jaredzhou/foxql/ast.Expr
Expr

Column::lt_select

source

fn[T] Column::lt_select(self : Column[T], subquery : @jaredzhou/foxql/ast.SelectStmt
SelectStmt) -> @jaredzhou/foxql/ast.Expr
Expr

Column::lte

source

fn[T : Comparable + @jaredzhou/foxql/ast.ToValue
ToValue] Column::lte(self : Column[T], value : T) -> @jaredzhou/foxql/ast.Expr
Expr

Column::lte_select

source

fn[T] Column::lte_select(self : Column[T], subquery : @jaredzhou/foxql/ast.SelectStmt
SelectStmt) -> @jaredzhou/foxql/ast.Expr
Expr

Column::neq

source

fn[T : @jaredzhou/foxql/ast.ToValue
ToValue] Column::neq(self : Column[T], value : T) -> @jaredzhou/foxql/ast.Expr
Expr

Column::neq_select

source

fn[T] Column::neq_select(self : Column[T], subquery : @jaredzhou/foxql/ast.SelectStmt
SelectStmt) -> @jaredzhou/foxql/ast.Expr
Expr

Column::new

source

fn[T] Column::new(name : String, table : String, sql_type : @jaredzhou/foxql/ast.SqlType
SqlType) -> Column[T]

Create a new column reference.

Column::not_like

source

fn[T : StringMatchable] Column::not_like(self : Column[T], pattern : String) -> @jaredzhou/foxql/ast.Expr
Expr

Column::to_ref

source

fn[T] Column::to_ref(self : Column[T]) -> @jaredzhou/foxql/ast.ColumnRef
ColumnRef

Produce a type-erased ColumnRef.

DeleteBuilder

source

pub(all) struct DeleteBuilder {
  table : Table
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

A pending DELETE builder. Must call .where_() before .to_sql().

DeleteBuilder::new

source

fn DeleteBuilder::new(table : Table) -> DeleteBuilder

Create a new DeleteBuilder. Internal — users call table.delete().

DeleteBuilder::where_

source

fn DeleteBuilder::where_(self : DeleteBuilder, condition : @jaredzhou/foxql/ast.Expr
Expr) -> DeleteReady

Attach a WHERE clause. Promotes to DeleteReady.

DeleteReady

source

pub(all) struct DeleteReady {
  table : Table
  where_clause : @jaredzhou/foxql/ast.Expr
Expr
  returning : Array[@jaredzhou/foxql/ast.ColumnRef
ColumnRef]?
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

A complete DELETE builder with a WHERE clause. Terminal: .to_sql().

DeleteReady::returning

source

fn DeleteReady::returning(self : DeleteReady, cols : Array[&AnyColumn]) -> DeleteReady

Attach a RETURNING clause.

DeleteReady::to_sql

source

fn DeleteReady::to_sql(self : DeleteReady) -> (String, Array[@jaredzhou/foxql/ast.Value
Value])

Render the query to a parameterised SQL string + args array.

InsertBuilder

source

pub(all) struct InsertBuilder {
  table : Table
  columns : Array[@jaredzhou/foxql/ast.ColumnRef
ColumnRef]
  values : Array[Array[@jaredzhou/foxql/ast.Value
Value]]
  conflict_cols : Array[@jaredzhou/foxql/ast.ColumnRef
ColumnRef]
  conflict_action : Int
  conflict_sets : Array[@jaredzhou/foxql/ast.SetClause
SetClause]
  returning : Array[@jaredzhou/foxql/ast.ColumnRef
ColumnRef]?
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

A fluent builder for an INSERT query. Terminal: .to_sql().

InsertBuilder::do_nothing

source

fn InsertBuilder::do_nothing(self : InsertBuilder) -> InsertBuilder

ON CONFLICT DO NOTHING.

InsertBuilder::do_update

source

fn InsertBuilder::do_update(self : InsertBuilder, column : &AnyColumn, value : &@jaredzhou/foxql/ast.ToValue
ToValue) -> InsertBuilder

ON CONFLICT DO UPDATE SET column = value.

InsertBuilder::new

source

fn InsertBuilder::new(table : Table, columns : Array[&AnyColumn]) -> InsertBuilder

Create a new InsertBuilder. Internal — users call table.insert(..) instead.

InsertBuilder::on_conflict

source

fn InsertBuilder::on_conflict(self : InsertBuilder, cols : Array[&AnyColumn]) -> InsertBuilder

Set the ON CONFLICT target column(s).

InsertBuilder::returning

source

fn InsertBuilder::returning(self : InsertBuilder, cols : Array[&AnyColumn]) -> InsertBuilder

Attach a RETURNING clause.

InsertBuilder::rows

source

fn InsertBuilder::rows(self : InsertBuilder, rows : Array[Array[&@jaredzhou/foxql/ast.ToValue
ToValue]]) -> InsertBuilder

Add a multi-row VALUES clause.

InsertBuilder::to_sql

source

fn InsertBuilder::to_sql(self : InsertBuilder) -> (String, Array[@jaredzhou/foxql/ast.Value
Value])

Render the query to a parameterised SQL string + args array.

InsertBuilder::values

source

fn InsertBuilder::values(self : InsertBuilder, vals : Array[&@jaredzhou/foxql/ast.ToValue
ToValue]) -> InsertBuilder

Add a single-row VALUES clause.

SelectBuilder

source

pub(all) struct SelectBuilder {
  table : Table
  columns : Array[@jaredzhou/foxql/ast.ColumnRef
ColumnRef]
  aggregates : Array[@jaredzhou/foxql/ast.Aggregation
Aggregation]
  where_clause : @jaredzhou/foxql/ast.Expr
Expr?
  joins : Array[@jaredzhou/foxql/ast.JoinClause
JoinClause]
  group_by : Array[@jaredzhou/foxql/ast.ColumnRef
ColumnRef]
  having : @jaredzhou/foxql/ast.Expr
Expr?
  order_by : Array[@jaredzhou/foxql/ast.OrderByClause
OrderByClause]
  limit : Int?
  offset : Int?
  distinct : Bool
  distinct_on : Array[@jaredzhou/foxql/ast.ColumnRef
ColumnRef]
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

A fluent builder for a SELECT query. Terminal: .to_sql() or .build().

SelectBuilder::agg

source

fn SelectBuilder::agg(self : SelectBuilder, a : @jaredzhou/foxql/ast.Aggregation
Aggregation) -> SelectBuilder

Add an aggregate expression to the SELECT list.

SelectBuilder::build

source

fn SelectBuilder::build(self : SelectBuilder) -> @jaredzhou/foxql/ast.SelectStmt
SelectStmt

Produce the AST node without rendering.

SelectBuilder::distinct

source

fn SelectBuilder::distinct(self : SelectBuilder) -> SelectBuilder

Add SELECT DISTINCT.

SelectBuilder::distinct_on

source

fn SelectBuilder::distinct_on(self : SelectBuilder, cols : Array[&AnyColumn]) -> SelectBuilder

Add SELECT DISTINCT ON (columns).

SelectBuilder::group_by

source

fn SelectBuilder::group_by(self : SelectBuilder, cols : Array[&AnyColumn]) -> SelectBuilder

Add a GROUP BY clause.

SelectBuilder::having

source

fn SelectBuilder::having(self : SelectBuilder, condition : @jaredzhou/foxql/ast.Expr
Expr) -> SelectBuilder

Attach a HAVING clause (must be after GROUP BY).

SelectBuilder::join

source

fn SelectBuilder::join(self : SelectBuilder, other : Table, on : @jaredzhou/foxql/ast.Expr
Expr) -> SelectBuilder

Add an INNER JOIN clause.

SelectBuilder::limit

source

fn SelectBuilder::limit(self : SelectBuilder, n : Int) -> SelectBuilder

Attach a LIMIT clause.

SelectBuilder::new

source

fn SelectBuilder::new(table : Table, columns : Array[@jaredzhou/foxql/ast.ColumnRef
ColumnRef]) -> SelectBuilder

Create a new SelectBuilder. Internal — users call table.select(..) instead.

SelectBuilder::offset

source

fn SelectBuilder::offset(self : SelectBuilder, n : Int) -> SelectBuilder

Attach an OFFSET clause.

SelectBuilder::order_by

source

fn SelectBuilder::order_by(self : SelectBuilder, clause : @jaredzhou/foxql/ast.OrderByClause
OrderByClause) -> SelectBuilder

Add an ORDER BY clause. Chain multiple times for multiple columns.

SelectBuilder::to_sql

source

fn SelectBuilder::to_sql(self : SelectBuilder) -> (String, Array[@jaredzhou/foxql/ast.Value
Value])

Render the query to a parameterised SQL string + args array.

SelectBuilder::where_

source

fn SelectBuilder::where_(self : SelectBuilder, condition : @jaredzhou/foxql/ast.Expr
Expr) -> SelectBuilder

Attach a WHERE clause to this SELECT.

Table

source

pub(all) struct Table {
  name : String
  schema_name : String?
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Table identity — name and optional schema.

Table::delete

source

fn Table::delete(self : Table) -> DeleteBuilder

Start building a DELETE query on this table. Requires .where_() before .to_sql().

Table::insert

source

fn Table::insert(self : Table, columns : Array[&AnyColumn]) -> InsertBuilder

Start building an INSERT query on this table.

Table::new

source

fn Table::new(name : String, schema? : String) -> Table

Create a table, optionally qualified with a schema.

Table::qualified_name

source

fn Table::qualified_name(self : Table) -> String

Return the fully-qualified table name for use in SQL (schema.name or name).

Table::select

source

fn Table::select(self : Table, columns? : Array[&AnyColumn]) -> SelectBuilder

Start building a SELECT query on this table. Omit columns for SELECT *.

Table::update

source

fn Table::update(self : Table) -> UpdateBuilder

Start building an UPDATE query on this table. Requires .where_() before .to_sql().

UpdateBuilder

source

pub(all) struct UpdateBuilder {
  table : Table
  set_clauses : Array[@jaredzhou/foxql/ast.SetClause
SetClause]
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

A pending UPDATE builder. Must call .where_() before .to_sql().

UpdateBuilder::new

source

fn UpdateBuilder::new(table : Table) -> UpdateBuilder

Create a new UpdateBuilder. Internal — users call table.update().

UpdateBuilder::set

source

fn UpdateBuilder::set(self : UpdateBuilder, column : &AnyColumn, value : &@jaredzhou/foxql/ast.ToValue
ToValue) -> UpdateBuilder

Add a SET clause. Column as &AnyColumn, value as &ToValue.

UpdateBuilder::where_

source

fn UpdateBuilder::where_(self : UpdateBuilder, condition : @jaredzhou/foxql/ast.Expr
Expr) -> UpdateReady

Attach a WHERE clause. Promotes to UpdateReady.

UpdateReady

source

pub(all) struct UpdateReady {
  table : Table
  set_clauses : Array[@jaredzhou/foxql/ast.SetClause
SetClause]
  where_clause : @jaredzhou/foxql/ast.Expr
Expr
  returning : Array[@jaredzhou/foxql/ast.ColumnRef
ColumnRef]?
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

A complete UPDATE builder with a WHERE clause. Terminal: .to_sql().

UpdateReady::returning

source

fn UpdateReady::returning(self : UpdateReady, cols : Array[&AnyColumn]) -> UpdateReady

Attach a RETURNING clause.

UpdateReady::to_sql

source

fn UpdateReady::to_sql(self : UpdateReady) -> (String, Array[@jaredzhou/foxql/ast.Value
Value])

Render the query to a parameterised SQL string + args array.

avg

source

fn[T] avg(col : Column[T]) -> @jaredzhou/foxql/ast.Aggregation
Aggregation

count

source

fn[T] count(col : Column[T]) -> @jaredzhou/foxql/ast.Aggregation
Aggregation

count_star

source

fn count_star() -> @jaredzhou/foxql/ast.Aggregation
Aggregation

COUNT(*) — count all rows.

max

source

fn[T] max(col : Column[T]) -> @jaredzhou/foxql/ast.Aggregation
Aggregation

min

source

fn[T] min(col : Column[T]) -> @jaredzhou/foxql/ast.Aggregation
Aggregation

sum

source

fn[T] sum(col : Column[T]) -> @jaredzhou/foxql/ast.Aggregation
Aggregation

Source Files

Site source Report issue Packages Build queue Skills Statistics

#AnyColumn

#Comparable

#StringMatchable

#Column

#Column::asc

#Column::between

#Column::desc

#Column::eq

#Column::eq_col

#Column::eq_select

#Column::gt

#Column::gt_select

#Column::gte

#Column::gte_select

#Column::in_

#Column::in_select

#Column::is_not_null

#Column::is_null

#Column::like

#Column::lt

#Column::lt_select

#Column::lte

#Column::lte_select

#Column::neq

#Column::neq_select

#Column::new

#Column::not_like

#Column::to_ref

#DeleteBuilder

#DeleteBuilder::new

#DeleteBuilder::where_

#DeleteReady

#DeleteReady::returning

#DeleteReady::to_sql

#InsertBuilder

#InsertBuilder::do_nothing

#InsertBuilder::do_update

#InsertBuilder::new

#InsertBuilder::on_conflict

#InsertBuilder::returning

#InsertBuilder::rows

#InsertBuilder::to_sql

#InsertBuilder::values

#SelectBuilder

#SelectBuilder::agg

#SelectBuilder::build

#SelectBuilder::distinct

#SelectBuilder::distinct_on

#SelectBuilder::group_by

#SelectBuilder::having

#SelectBuilder::join

#SelectBuilder::limit

#SelectBuilder::new

#SelectBuilder::offset

#SelectBuilder::order_by

#SelectBuilder::to_sql

#SelectBuilder::where_

#Table

#Table::delete

#Table::insert

#Table::new

#Table::qualified_name

#Table::select

#Table::update

#UpdateBuilder

#UpdateBuilder::new

#UpdateBuilder::set

#UpdateBuilder::where_

#UpdateReady

#UpdateReady::returning

#UpdateReady::to_sql

#avg

#count

#count_star

#max

#min

#sum

Source Files

AnyColumn

Comparable

StringMatchable

Column

Column::asc

Column::between

Column::desc

Column::eq

Column::eq_col

Column::eq_select

Column::gt

Column::gt_select

Column::gte

Column::gte_select

Column::in_

Column::in_select

Column::is_not_null

Column::is_null

Column::like

Column::lt

Column::lt_select

Column::lte

Column::lte_select

Column::neq

Column::neq_select

Column::new

Column::not_like

Column::to_ref

DeleteBuilder

DeleteBuilder::new

DeleteBuilder::where_

DeleteReady

DeleteReady::returning

DeleteReady::to_sql

InsertBuilder

InsertBuilder::do_nothing

InsertBuilder::do_update

InsertBuilder::new

InsertBuilder::on_conflict

InsertBuilder::returning

InsertBuilder::rows

InsertBuilder::to_sql

InsertBuilder::values

SelectBuilder

SelectBuilder::agg

SelectBuilder::build

SelectBuilder::distinct

SelectBuilder::distinct_on

SelectBuilder::group_by

SelectBuilder::having

SelectBuilder::join

SelectBuilder::limit

SelectBuilder::new

SelectBuilder::offset

SelectBuilder::order_by

SelectBuilder::to_sql

SelectBuilder::where_

Table

Table::delete

Table::insert

Table::new

Table::qualified_name

Table::select

Table::update

UpdateBuilder

UpdateBuilder::new

UpdateBuilder::set

UpdateBuilder::where_

UpdateReady

UpdateReady::returning

UpdateReady::to_sql

avg

count

count_star

max

min

sum