Module Caqti_eio_unix

Establinging Connections for Eio with Unix

This module provides database connections for applications using Eio. It supports all database drivers.

The caqti-eio library should be considered unstable for now. Eio is in active development including its API, and the Caqti interface to it may benefit from further revision before the first major Eio release lands.

include Caqti_connect_sig.S with type 'a fiber := 'a and type ('a, 'e) stream := ('a, 'e) Caqti_eio.Stream.t and type ('a, 'e) pool := ('a, 'e) Caqti_eio.Pool.t and type connection := Caqti_eio.connection and type 'a with_switch := sw:Eio.Switch.t -> 'a and type 'a with_stdenv := stdenv:Caqti_eio.stdenv -> 'a
val connect : ?env:(Caqti_driver_info.t -> string -> Caqti_query.t) -> ?tweaks_version:(int * int) -> sw:Eio.Switch.t -> stdenv:Caqti_eio.stdenv -> Uri.t -> (Caqti_eio.connection, [> Caqti_error.load_or_connect ]) Stdlib.result

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.

If you use preemptive threading, note that the connection must only be used from the thread where it was created.

See Database Tweaks for details about the tweaks_version parameter.

  • parameter tweaks_version

    Declares compatibility with database tweaks introduced up to the given version of Caqti. Defaults to a conservative value. See the above reference for more info (not linked here due to odoc issue).

  • parameter env

    If provided, this function will do a final expansion of environment variables which occurs in the query templates of the requests executed on the connection.

val with_connection : ?env:(Caqti_driver_info.t -> string -> Caqti_query.t) -> ?tweaks_version:(int * int) -> stdenv:Caqti_eio.stdenv -> Uri.t -> (Caqti_eio.connection -> ('a, [> Caqti_error.load_or_connect ] as 'e) Stdlib.result) -> ('a, 'e) Stdlib.result

with_connection uri f calls connect on uri. If connect evaluates to Ok connection, with_connection passes the connection to f. Once f either evaluates to a result, or raises an exception, with_connection closes the database connection.

  • parameter tweaks_version

    Passed to connect.

val connect_pool : ?pool_config:Caqti_pool_config.t -> ?post_connect:(Caqti_eio.connection -> (unit, 'connect_error) Stdlib.result) -> ?env:(Caqti_driver_info.t -> string -> Caqti_query.t) -> ?tweaks_version:(int * int) -> sw:Eio.Switch.t -> stdenv:Caqti_eio.stdenv -> Uri.t -> ((Caqti_eio.connection, [> Caqti_error.connect ] as 'connect_error) Caqti_eio.Pool.t, [> Caqti_error.load ]) Stdlib.result

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

Do not use pooling for connections to volatile resources like sqlite3::memory: and beware of temporary tables or other objects which may not be shared across connections to the same URI.

If you use preemptive threading, note that the connection pool must only be used from the thread where it was created. Use thread local storage to create a separate pool per thread if necessary.

  • parameter tweaks_version

    Passed to connect when creating new connections.

  • parameter env

    Passed to connect when creating new connections.