package caqti

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

Install

Dune Dependency

Authors

Maintainers

Sources

caqti-v1.2.0.tbz
sha256=bc67a61e9c43f1cd9ab54476bdd4ea6495decd281aececcb4062c29713a7391d
sha512=17018a142bd29be3b503c6b6f5320ec65b3418a46bb82c0127f5ff198890d56bd9e50263ce20930e8c6e0dadb8bdf5f43b6479fc111948d44e3170715e40c290

doc/caqti.blocking/Caqti_blocking/index.html

Module Caqti_blockingSource

Blocking API based on the Unix module.

Warning: This module is not well tested. Please report any issues.

This module implements a blocking API. It is not designed for preemptive threading. That is, connections and connection pools must be created and used within a single thread, and any limitation on multithreading from the driver or client library applies.

You can use a connection pool to cache a single DB connection, additional connections will not be allocated, since usage is serial.

include Caqti_connect_sig.S with type 'a future = 'a
Sourcetype 'a future = 'a

The type of a deferred value of type 'a.

module Pool : Caqti_pool_sig.S with type 'a future := 'a future

A pool implementation for the current concurrency library.

module Stream : Caqti_stream.S with type 'a future := 'a future
Sourcemodule type CONNECTION = Caqti_connection_sig.S with type 'a future := 'a future and type ('a, 'err) stream := ('a, 'err) Stream.t

The connection API specialized for the current concurrency library.

Sourcetype connection = (module CONNECTION)

Shortcut for the connection API passed as a value.

connect uri locates and loads a driver which can handle uri, passes uri to the driver, which establish a connection and returns a first-class module implementing Caqti_connection_sig.S.

Sourceval connect_pool : ?max_size:int -> Uri.t -> ((connection, [> Caqti_error.connect ]) Pool.t, [> Caqti_error.load ]) result

connect_pool uri is a pool of database connections constructed by connect uri.

Sourceval or_fail : ('a, [< Caqti_error.t ]) result -> 'a

Takes Ok x to x and raises Caqti_error.Exnerr on Error err.

OCaml

Innovation. Community. Security.