package caqti

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

Install 

dune-project
 Dependency

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

Authors

  1. P
    Petter A. Urkedal

Maintainers

  1. P
    paurkedal@gmail.com

Sources

caqti-0.10.2.tbz
sha256=d688bd22f6fde5be5a755900545fade0d5fdce6dbcb0b85770d02dad87c41e7c
md5=d18745a703da336054c0d27e78f8be8a

doc/caqti/Caqti_connection_sig/module-type-Base/index.html

Module type Caqti_connection_sig.BaseSource

Essential connection signature implemented by drivers.

Sourcetype 'a future

Query

Sourcemodule Response : Caqti_response_sig.S with type 'a future := 'a future
Sourceval call : f:(('b, 'm) Response.t -> ('c, 'e) result future) -> ('a, 'b, 'm) Caqti_request.t -> 'a -> ('c, [> Caqti_error.call ] as 'e) result future

call ~f request params performs request with parameters params invoking f to process the result.

Transactions

Sourceval start : unit -> (unit, [> Caqti_error.transact ]) result future

Starts a transaction if supported by the underlying database, otherwise does nothing.

Sourceval commit : unit -> (unit, [> Caqti_error.transact ]) result future

Commits the current transaction if supported by the underlying database, otherwise does nothing.

Sourceval rollback : unit -> (unit, [> Caqti_error.transact ]) result future

Rolls back a transaction if supported by the underlying database, otherwise does nothing.

Disconnection and Reuse

Sourceval disconnect : unit -> unit future

Calling disconnect () closes the connection to the database and frees up related resources.

Sourceval validate : unit -> bool future

For internal use by Caqti_pool. Tries to ensure the validity of the connection and must return false if unsuccessful.

Sourceval check : (bool -> unit) -> unit

For internal use by Caqti_pool. Called after a connection has been used. check f must call f () exactly once with an argument indicating whether to keep the connection in the pool or discard it.