package sequoia

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Parameters
Signature

package sequoia

sequoia
- Sequoia
  - Make
    
    D
    
    Delete
    
    Expr
    
    Expr
    
    Base
    
    Null
    
    Vector
    
    FIELD
    
    Field
    
    Null
    
    Insert
    
    Vector
    
    Lit
    
    Null
    
    MakeTable
    
    Field
    
    Null
    
    T
    
    NULL_FIELD
    
    Param
    
    Replace
    
    Vector
    
    Select
    
    Expr
    
    Vector
    
    OrderBy
    
    Expr
    
    Vector
    
    Vector
    
    TABLE
    
    Field
    
    Null
    
    Table
    
    Update
    
    Expr
    
    Vector
    
    OrderBy
    
    Expr
    
    Vector
    
    Vector
    
    Vector
    
    Vector
    
    Elem
    
    Make
    
    E
    
    Nat
    
    S
  - NAMED
  - S
    
    Delete
    
    Expr
    
    Expr
    
    Base
    
    Null
    
    Vector
    
    FIELD
    
    Field
    
    Null
    
    Insert
    
    Vector
    
    Lit
    
    Null
    
    Vector
    
    MakeTable
    
    Field
    
    Null
    
    T
    
    NULL_FIELD
    
    Param
    
    Replace
    
    Vector
    
    Select
    
    Expr
    
    Vector
    
    OrderBy
    
    Expr
    
    Vector
    
    Vector
    
    TABLE
    
    Field
    
    Null
    
    Table
    
    Update
    
    Expr
    
    Vector
    
    OrderBy
    
    Expr
    
    Vector
    
    Vector
    
    Vector
    
    Vector
    
    Elem
    
    Make
    
    E
    
    Nat
    
    S
- Sequoia_common
  - AliasSet
- Sequoia_delete
  - Make
    
    D
    
    Expr
  - S
    
    Expr
- Sequoia_driver
  - S
- Sequoia_expr
  - Base
    
    Null
  - Vector
- Sequoia_field
  - Null
- Sequoia_insert
  - Make
    
    D
    
    Vector
  - S
    
    Vector
- Sequoia_lit
  - Null
  - Vector
- Sequoia_param
- Sequoia_query_common
  - InsertReplace
    
    Vector
  - UpdateDeleteExpr
- Sequoia_replace
  - Make
    
    D
    
    Vector
  - S
    
    Vector
- Sequoia_select
  - Make
    
    D
    
    Expr
    
    Vector
    
    OrderBy
    
    Expr
    
    Vector
    
    Vector
  - S
    
    Expr
    
    Vector
    
    OrderBy
    
    Expr
    
    Vector
    
    Vector
- Sequoia_table
- Sequoia_update
  - Make
    
    D
    
    Expr
    
    Vector
    
    OrderBy
    
    Expr
    
    Vector
    
    Vector
    
    Vector
  - S
    
    Expr
    
    Vector
    
    OrderBy
    
    Expr
    
    Vector
    
    Vector
    
    Vector
- Sequoia_vector
  - Elem
  - Make
    
    E
  - Nat
  - S
sequoia.mysql
- Sequoia_mysql
  - D
  - Delete
  - Enum
    
    Instance
    
    S
  - Expr
  - FIELD
  - Field
    
    Null
  - Insert
    
    Vector
  - Lit
  - M
    
    Delete
    
    Expr
    
    Expr
    
    Base
    
    Null
    
    Vector
    
    FIELD
    
    Field
    
    Null
    
    Insert
    
    Vector
    
    Lit
    
    Null
    
    Vector
    
    MakeTable
    
    Field
    
    Null
    
    T
    
    NULL_FIELD
    
    Param
    
    Replace
    
    Vector
    
    Select
    
    Expr
    
    Vector
    
    OrderBy
    
    Expr
    
    Vector
    
    Vector
    
    TABLE
    
    Field
    
    Null
    
    Table
    
    Update
    
    Expr
    
    Vector
    
    OrderBy
    
    Expr
    
    Vector
    
    Vector
    
    Vector
    
    Vector
    
    Elem
    
    Make
    
    E
    
    Nat
    
    S
  - MYSQL_FIELD
  - MYSQL_NULL_FIELD
  - MYSQL_TABLE
    
    Field
    
    Null
  - MakeMysqlTable
    
    Field
    
    Null
    
    T
  - MakeTable
    
    Field
    
    Null
    
    T
  - NULL_FIELD
  - Param
  - Replace
    
    Vector
  - Select
    
    Expr
    
    OrderBy
    
    Expr
    
    Vector
    
    Vector
  - TABLE
    
    Field
    
    Null
  - Table
  - Update
  - Vector
    
    Elem
    
    Make
    
    E
    
    Nat
    
    S
sequoia.ppx
- Sequoia_ppx
sequoia.sqlite
- Sequoia_sqlite
  - D
  - Delete
  - Expr
  - FIELD
  - Insert
    
    Vector
  - M
    
    Delete
    
    Expr
    
    Expr
    
    Base
    
    Null
    
    Vector
    
    FIELD
    
    Field
    
    Null
    
    Insert
    
    Vector
    
    Lit
    
    Null
    
    Vector
    
    MakeTable
    
    Field
    
    Null
    
    T
    
    NULL_FIELD
    
    Param
    
    Replace
    
    Vector
    
    Select
    
    Expr
    
    Vector
    
    OrderBy
    
    Expr
    
    Vector
    
    Vector
    
    TABLE
    
    Field
    
    Null
    
    Table
    
    Update
    
    Expr
    
    Vector
    
    OrderBy
    
    Expr
    
    Vector
    
    Vector
    
    Vector
    
    Vector
    
    Elem
    
    Make
    
    E
    
    Nat
    
    S
  - MakeTable
    
    Field
    
    Null
    
    T
  - NULL_FIELD
  - Param
  - Replace
    
    Vector
  - Select
  - TABLE
    
    Field
    
    Null
  - Table
  - Update
  - Vector
    
    Elem
    
    Make
    
    E
    
    Nat
    
    S

Legend:
Library
Module
Module type
Parameter
Class
Class type

Functor that generates a SELECT query builder for the given driver.

Parameters

module D : Sequoia_driver.S

Signature

type _ t

The type of SELECT queries.

type ('s1, 't1, 't2, 's2) join_steps =

| There : (('t2 -> _) as 's1, 't1, 't2, 't1 -> 's1) join_steps
| Skip : ('s1, 't1, 't2, 's2) join_steps -> ('a -> 's1, 't1, 't2, 'a -> 's2) join_steps
(*
This type allows the representation of SQL joins in the OCaml type system.
*)

type join

The type of SQL joins.

type 's source =

| From : 't Sequoia_table.t -> ('t -> unit) source
| Join : join * ('t1, 't2) Sequoia_field.foreign_key * 's1 source * ('s1, 't1, 't2, 's2) join_steps -> 's2 source
(*
Data sources for SELECT queries: tables specified in the the FROM or JOIN clause. Joins are only allowed on fields declared as foreign keys. The join_steps type joins the tables in the OCaml type system sense.
*)

type ('s1, 't1, 't2, 's2) steps =

| There : (('t2 -> _) as 's1, 't1, 't2, 's1) steps
| Skip : ('s1, 't1, 't2, 's2) steps -> ('a -> 's1, 't1, 't2, 'a -> 's2) steps
(*
This is analogous to join_steps but instead of building the set of data sources (i.e. the tables being referenced in the query), it is used to simply reference them.
*)

val seal : 
  handover:Sequoia_expr.handover ->
  's t ->
  string * Sequoia_param.t list

Mark the end of a SELECT query.

module Expr : sig ... end

Expressions that are valid in SELECT queries.

val select : 
  ?distinct:bool ->
  ('s, 'a, 'n Sequoia_vector.Nat.s) Expr.Vector.t ->
  's source ->
  's t

Define the selected expressions in a SELECT query.

val from : 't Sequoia_table.t -> ('t -> unit) source

Starts a SELECT query by specifying the initial data source.

val left_join : 
  (('t1, 't2) Sequoia_field.foreign_key * ('s1, 't1, 't2, 's2) join_steps) ->
  's1 source ->
  's2 source

Specifies a LEFT JOIN adding the table containing the given foreign key as a data source.

val right_join : 
  (('t1, 't2) Sequoia_field.foreign_key * ('s1, 't1, 't2, 's2) join_steps) ->
  's1 source ->
  's2 source

Specifies a RIGHT JOIN adding the table containing the given foreign key as a data source.

val inner_join : 
  (('t1, 't2) Sequoia_field.foreign_key * ('s1, 't1, 't2, 's2) join_steps) ->
  's1 source ->
  's2 source

Specifies an INNER JOIN adding the table containing the given foreign key as a data source.

val self : 
  ('t, int) Sequoia_field.t ->
  ('t, int) Sequoia_field.t ->
  ('s1, 't1, 't, 's2) join_steps ->
  ('t, 't) Sequoia_field.foreign_key * ('s1, 't1, 't, 's2) join_steps

Allows self-joins, i.e. joins that use fields belonging to a single table.

val this : 
  ('t1, 't2) Sequoia_field.foreign_key ->
  ('s1, 't1, 't2, 's2) join_steps ->
  ('t1, 't2) Sequoia_field.foreign_key * ('s1, 't1, 't2, 's2) join_steps

Call this on a foreign key when you want to define a join with the table that contains the foreign key.

val that : 
  ('t1, 't2) Sequoia_field.foreign_key ->
  ('s1, 't2, 't1, 's2) join_steps ->
  ('t2, 't1) Sequoia_field.foreign_key * ('s1, 't2, 't1, 's2) join_steps

Call this on a foreign key when you want to define a join with the table that contains the field that the foreign key references.

val where : ('a source -> bool Expr.t) -> 'a t -> 'a t

Defines a WHERE clause for a SELECT query.

val group_by : 
  ?having:('s source -> bool Expr.t) ->
  ('s, 'a, 'n Sequoia_vector.Nat.s) Expr.Vector.t ->
  's t ->
  's t

Defines a GROUP BY clause for a SELECT query.

module OrderBy : sig ... end

Definitions for ORDER BY clauses.

val order_by : 
  ('s, 'a, 'n Sequoia_vector.Nat.s) OrderBy.Expr.Vector.t ->
  's t ->
  's t

Defines an ORDER BY clause in a SELECT query.

val limit : ?offset:int -> int -> 'a t -> 'a t

Defines a LIMIT clause in a SELECT query.