package caqti-eio
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=7eb57225c521fe25395653d960b1c381bb2b2ccae47bc2a827bb16611988da8b
sha512=eeafaf495b08fb8620ddee1711b8f9fa2ca0c79fb450a905c8d071806b7046d665e1e2ac0e7d3c7ca1258455decbf184e689e9ecb2453ec9d952b864f9dd14f4
doc/caqti-eio.unix/Caqti_eio_unix/index.html
Module Caqti_eio_unixSource
Establinging Connections for Eio with Unix
This module provides database connections for applications using Eio. It supports all database drivers.
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 ]) resultconnect 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.
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) result) ->
('a, 'e) resultval connect_pool :
?pool_config:Caqti_pool_config.t ->
?post_connect:(Caqti_eio.connection -> (unit, 'connect_error) 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 ])
resultconnect_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.