package sequoia

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Useful values 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

Literal values.

Expressions.

Expressions that (supposedly) exist on every SQL implementation. Everything else is left to be implemented in drivers.

type 'a t = ..

The type of expressions. It is extended by the query modules (i.e. Sequoia_select, Sequoia_insert, etc.) to account for expressions that are only valid for the respective query types.

type 'a cast = ..

The type of expressions. It is extended by the query modules (i.e. Sequoia_select, Sequoia_insert, etc.) to account for expressions that are only valid for the respective query types.

The type that represents an SQL CAST().

module Base : sig ... end

Module Base defines the basic SQL expressions.

Useful values for driver writers

type handover = {

expr : 'a. Sequoia_common.build_step -> 'a t -> Sequoia_common.build_step;
cast : 'b. 'b cast -> string;

}

These are functions that allow an expression to be "handed over" to another function when they're being built. The handover type makes it possible to recursively build expressions that can contain driver-specific constructors.

val build : 
  placeholder:(int -> string) ->
  handover:handover ->
  Sequoia_common.build_step ->
  'a t ->
  Sequoia_common.build_step

Build an expression.

val build_function : 
  placeholder:(int -> string) ->
  handover:handover ->
  Sequoia_common.build_step ->
  string ->
  'a t list ->
  string ->
  Sequoia_common.build_step

Build an expression that corresponds to an SQL function.

val string_of_cast : ?handover:('a cast -> string) -> 'a cast -> string

Convert a CAST expression to a string representation.

type ('a, 'b) expr = 'b t

module Vector : Sequoia_vector.S with type ('a, 'b) elem := ('a, 'b) expr

A module for vectors of expressions.