package caqti

  1. Overview
  2. Docs
Unified interface to relational database libraries

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (21)

Authors

  1. P
    Petter A. Urkedal <paurkedal@gmail.com>
  2. N
    Nathan Rebours <nathan@cryptosense.com>

Maintainers

  1. P
    Petter A. Urkedal <paurkedal@gmail.com>

Sources

caqti-v1.9.0.tbz
sha256=e1f580848faf3a54f23174067f2c75f77f6a2fe50ca8bc923428d0e1841192c5
sha512=7a11edfcfbbe4855347b066e222cf6bf46d1afedcd4978661b9a2b3931921faa1768a6bc24031fd3afa84537fe2adc8b139399deb77120461bee8fb394d68e82

doc/caqti/Caqti_driver_lib/index.html

Module Caqti_driver_libSource

Internal: Library for Drivers

Sourceval linear_param_length : ?env:(string -> Caqti_query.t) -> Caqti_query.t -> int

linear_param_length templ is the number of linear parameters expected by a query represented by templ.

Sourceval linear_param_order : ?env:(string -> Caqti_query.t) -> Caqti_query.t -> int list list * (int * string) list

linear_param_order templ describes the parameter bindings expected for templ after linearizing parameters and lifting quoted strings out of the query:

  • The first is a list where item number i is a list of linear parameter positions to which to bind the ith incoming parameter.
  • The second is a list of pairs where the first component is the position of the linear parameter taking the place of a quoted string, and the second component is the quoted string to bind to this parameter.

All positions are zero-based.

Sourceval linear_query_string : ?env:(string -> Caqti_query.t) -> Caqti_query.t -> string

linear_query_string templ is templ where "?" is substituted for parameters and quoted strings.

Sourcetype ('a, 'e) field_encoder = {
  1. write_value : 'b. uri:Uri.t -> 'b Caqti_type.Field.t -> 'b -> 'a -> ('a, 'e) result;
  2. write_null : 'b. uri:Uri.t -> 'b Caqti_type.Field.t -> 'a -> ('a, 'e) result;
} constraint 'e = [> `Encode_rejected of Caqti_error.coding_error ]
Sourceval encode_param : uri:Uri.t -> ('a, 'e) field_encoder -> 'b Caqti_type.t -> 'b -> 'a -> ('a, 'e) result
Sourcetype ('a, 'e) field_decoder = {
  1. read_value : 'b. uri:Uri.t -> 'b Caqti_type.Field.t -> 'a -> ('b * 'a, 'e) result;
  2. skip_null : int -> 'a -> 'a option;
} constraint 'e = [> `Decode_rejected of Caqti_error.coding_error ]
Sourceval decode_row : uri:Uri.t -> ('a, 'e) field_decoder -> 'b Caqti_type.t -> 'a -> ('b * 'a, 'e) result