package sequoia

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Functions useful for driver writers

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

Expressions that are valid in SELECT queries.

type 's select = 's t

type Sequoia_expr.t +=

| Field : ('t, 'a) Sequoia_field.t * 's1 source * ('s1, 't1, 't, 's2) steps -> 'a Sequoia_expr.t
| Foreign : ('t, 't2) Sequoia_field.foreign_key * 's1 source * ('s1, 't1, 't, 's2) steps -> 'a Sequoia_expr.t
| Select : 's select -> 'a Sequoia_expr.t
(*
Extend basic expressions with field and foreign key references and subqueries.
*)

type 'a t = 'a Sequoia_expr.t

val (-->) : ('s source -> 'a t) -> string -> 's source -> 'a t

Define an alias for an expression (i.e. the SQL AS keyword).

val alias : string -> 's source -> 'a t

Reference a previously defined alias. Note: alias references are not type-safe!

val field : 
  ('t, 'a) Sequoia_field.t ->
  ('b, 'c, 't, 'd) steps ->
  'b source ->
  'a t

A field expression.

val foreign_key : 
  ('t1, 't2) Sequoia_field.foreign_key ->
  ('a, 'b, 't1, 'c) steps ->
  'a source ->
  'd t

A foreign key expression.

val subquery : 's select -> 't source -> 'c t

A subquery expression.

val unwrap : 
  ('t, 'a option) Sequoia_field.t ->
  ('b, 'c, 't, 'd) steps ->
  'b source ->
  'a t

Convert a nullable field to an expression of the non-null type.

type ('s, 'a) mk = 's source -> 'a t

An expression builder, i.e. a function that returns an expression when given a source.

module Vector : Sequoia_vector.S with type ('s, 'a) elem := ('s, 'a) mk

Vectors of expression builders.

Functions useful for driver writers

val build : 
  handover:Sequoia_expr.handover ->
  Sequoia_common.build_step ->
  'a t ->
  Sequoia_common.build_step

Build an expression.

val vectormk_to_vector : 
  's source ->
  ('s, 'a, 'n) Vector.t ->
  ('s, 'a, 'n) Sequoia_expr.Vector.t

Convert a vector of expression builders into a vector of expressions when given a source.