package caqti-eio
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=483a535f41e2641917fc1832ce4ad15ffc3f4e8283b1b3018a2617349583090a
sha512=6a1222c0c55cb16a9d409980f9f2400340689b87e21aafed2d7459fd7feaeb109c2dfaf77f55f8422fbb7d3772342565ced7fed78a7b77af5aedab5bfd5ae882
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.
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) ->
?config:Caqti_connect_config.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.
connect uri connects to the database at uri and returns a first class module implementing Caqti_connection_sig.S for the given database system. In case of preemptive threading, the connection must only be used from the thread where it was created.
The correct driver for the database system is inferred from the schema of uri; see the respective drivers for the supported schemas and related URI syntax. A driver can either be linked in to the application or, if supported, dynamically linked using the caqti-dynload package.
val with_connection :
?env:(Caqti_driver_info.t -> string -> Caqti_query.t) ->
?config:Caqti_connect_config.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) ->
?config:Caqti_connect_config.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.