package sequoia

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Literal creation
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

Query parameters.

Literal values.

SQL literal values.

type 'a t = ..

The type of literals. Can be extended by drivers.

type t +=

| Bool : bool -> bool t
| Int : int -> int t
| Float : float -> float t
| String : string -> string t
| Blob : bytes -> bytes t
(*
Basic SQL literals.
*)

Literal creation

The functions below create literal values of the appropriate types.

val bool : bool -> bool t

val int : int -> int t

val float : float -> float t

val string : string -> string t

val blob : bytes -> bytes t

module Null : sig ... end

Literals for nullable fields.

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

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

Vectors of SQL literals.

Functions useful for driver writers

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

Build a literal value.

val to_param : 'a t -> Sequoia_param.t

Convert a literal value to a query parameter.