package caqti

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

Install 

dune-project
 Dependency

github.com Edit opam file Versions (22)

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.2.3.tbz
sha256=2fc68b60d90281e11a3272fa0e760cc22282a317b734778ab0bf987ed08a2f72
sha512=c0f214776bd2eda73f54ab0f64b89a90d12afc0b793308ee21374d70fc096073a24ae66fe0516304a4dc5da8ac5b98cd7df2d2eb88b002f616ef788105c1ec64

doc/caqti/Caqti_type/index.html

Module Caqti_typeSource

Type descriptors for fields and tuples.

Primitive Field Types

The following is normally only needed for drivers and to define new field types. Everything needed for common usage is covered in Row Types.

Sourcetype 'a field = ..

An extensible type describing primitive SQL types and types which can be converted to and from such types. When adding a new constructor, register the coding with Field.define_coding if possible. Otherwise, the type will only work with drivers which handle it themselves. The shipped drivers only handle the constructors listed here.

Sourcetype field +=
  1. | Bool : bool field
  2. | Int : int field
  3. | Int32 : int32 field
  4. | Int64 : int64 field
  5. | Float : float field
  6. | String : string field
  7. | Octets : string field
  8. | Pdate : Ptime.t field
  9. | Ptime : Ptime.t field
  10. | Ptime_span : Ptime.span field

Primitive field types handled by the shipped drivers.

Sourcemodule Field : sig ... end

Facilities for extending and using primitive field types.

Row Types

Sourcetype _ t = private
  1. | Unit : unit t
  2. | Field : 'a field -> 'a t
  3. | Option : 'a t -> 'a option t
  4. | Tup2 : 'a t * 'b t -> ('a * 'b) t
  5. | Tup3 : 'a t * 'b t * 'c t -> ('a * 'b * 'c) t
  6. | Tup4 : 'a t * 'b t * 'c t * 'd t -> ('a * 'b * 'c * 'd) t
  7. | Custom : {
    1. rep : 'b t;
    2. encode : 'a -> ('b, string) result;
    3. decode : 'b -> ('a, string) result;
    } -> 'a t

Type descriptor for row types.

Note. The concrete representation of this type should be considered private, including pattern-matching usage; use the below functions for compatibility with future versions.

Sourcetype any =
  1. | Any : 'a t -> any

t with existentially wrapped static type.

Sourceval length : 'a t -> int

length t is the number of fields used to represent t.

Sourceval pp : Format.formatter -> 'a t -> unit

pp ppf t prints a human presentation of t on ppf.

Sourceval pp_any : Format.formatter -> any -> unit

pp_any ppf t prints a human presentation of t on ppf.

Sourceval show : 'a t -> string

show t is a human presentation of t.

Sourceval field : 'a field -> 'a t

field ft is a row of a single field of type ft. This function can be used when adding new field types; use the below functions otherwise.

Sourcemodule Std : Caqti_type_sig.Std with type 'a t := 'a t

Standard type descriptors provided as a submodule for easy inclusion.

include Caqti_type_sig.Std with type 'a t := 'a t

Composite

The following provides constructors for narrow tuple types; to describe wider tuple types, use nested application.

Sourceval option : 'a t -> 'a option t
Sourceval unit : unit t

A holding no fields. This is used to pass no parameters and as the result for queries which does not return any rows. It can also be nested in tuples, in which case it will not contribute to the total number of fields.

Sourceval tup2 : 'a t -> 'b t -> ('a * 'b) t

Creates a pair type.

Sourceval tup3 : 'a t -> 'b t -> 'c t -> ('a * 'b * 'c) t

Creates a 3-tuple type.

Sourceval tup4 : 'a t -> 'b t -> 'c t -> 'd t -> ('a * 'b * 'c * 'd) t

Creates a 4-tuple type.

Sourceval custom : encode:('a -> ('b, string) result) -> decode:('b -> ('a, string) result) -> 'b t -> 'a t

custom ~encode ~decode rep creates a custom type represented by rep, where encode is used to encode parameters into rep and decode is used to decode result rows from rep.

Note. This should be considered experimental and may be revised or removed in a future version.

Singular

Sourceval bool : bool t

A boolean.

Sourceval int : int t

An integer.

Sourceval int32 : int32 t

A 32 bit integer.

Sourceval int64 : int64 t

A 64 bit integer.

Sourceval float : float t

A float.

Sourceval string : string t

An UTF-8 string. The database should accept UTF-8 if non-ASCII characters are present.

Sourceval octets : string t

A binary string.

Sourceval pdate : Ptime.t t

A date. This corresponds to the SQL date type.

Sourceval ptime : Ptime.t t

An absolute time with driver-dependent precision. This corresponds to an SQL timestamp type with UTC time zone.

Sourceval ptime_span : Ptime.span t

A period of time. If the database lacks a dedicated representation, the integer number of seconds is used.