package caqti
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=7eb57225c521fe25395653d960b1c381bb2b2ccae47bc2a827bb16611988da8b
sha512=eeafaf495b08fb8620ddee1711b8f9fa2ca0c79fb450a905c8d071806b7046d665e1e2ac0e7d3c7ca1258455decbf184e689e9ecb2453ec9d952b864f9dd14f4
doc/caqti.blocking/Caqti_blocking/index.html
Module Caqti_blockingSource
Blocking API based on the Unix module.
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.
module type CONNECTION =
Caqti_connection_sig.S
with type 'a fiber := 'a
and type ('a, 'e) stream := ('a, 'e) Stream.tinclude Caqti_connect_sig.S
with type 'a fiber := 'a
and type 'a with_switch := 'a
and type 'a with_stdenv := 'a
and type ('a, 'e) stream := ('a, 'e) Stream.t
and type ('a, 'e) pool := ('a, 'e) Pool.t
and type connection = (module CONNECTION)
Shortcut for the connection API passed as a value.
val connect :
?env:(Caqti_driver_info.t -> string -> Caqti_query.t) ->
?tweaks_version:(int * int) ->
Uri.t ->
(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) ->
Uri.t ->
(connection -> ('a, [> Caqti_error.load_or_connect ] as 'e) result) ->
('a, 'e) resultval connect_pool :
?pool_config:Caqti_pool_config.t ->
?post_connect:(connection -> (unit, 'connect_error) result) ->
?env:(Caqti_driver_info.t -> string -> Caqti_query.t) ->
?tweaks_version:(int * int) ->
Uri.t ->
((connection, [> Caqti_error.connect ] as 'connect_error) 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.
Takes Ok x to x and raises Caqti_error.Exn err on Error err.