package caqti-lwt

You can search for identifiers within the package.

in-package search v0.2.0

package caqti-lwt

caqti-lwt
- Caqti_lwt
  - CONNECTION
    
    Response
  - Pool
  - Stream
- Caqti_lwt_sql_io

Legend:
Library
Module
Module type
Parameter
Class
Class type

Connecting with Lwt.

This module contains the signature and connect function specialized for use with Lwt.

include Caqti_connect_sig.S with type 'a future := 'a Lwt.t

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

A pool implementation for the current concurrency library.

module Stream : Caqti_stream.S with type 'a future := 'a Lwt.t

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

The connection API specialized for the current concurrency library.

type connection = (module CONNECTION)

Shortcut for the connection API passed as a value.

val connect : 
  Uri.t ->
  (connection, [> Caqti_error.load_or_connect ]) Stdlib.result Lwt.t

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.

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

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

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

Converts an error to an Lwt future failed with a Caqti_error.Exn exception holding the error.