Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
Connector for Async.
include Caqti_connect_sig.S with type 'a future := 'a Async_kernel.Deferred.t
module Pool :
Caqti_pool_sig.S with type 'a future := 'a Async_kernel.Deferred.t
A pool implementation for the current concurrency library.
module Stream :
Caqti_stream.S with type 'a future := 'a Async_kernel.Deferred.t
module type CONNECTION =
Caqti_connection_sig.S
with type 'a future := 'a Async_kernel.Deferred.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 :
?env:(Caqti_driver_info.t -> string -> Caqti_query.t) ->
Uri.t ->
(connection, [> Caqti_error.load_or_connect ]) result Async_kernel.Deferred.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
.
If you use preemptive threading, note that the connection must only be used from the thread where it was created.
val with_connection :
?env:(Caqti_driver_info.t -> string -> Caqti_query.t) ->
Uri.t ->
(connection ->
('a, [> Caqti_error.load_or_connect ] as 'e) result Async_kernel.Deferred.t) ->
('a, 'e) result Async_kernel.Deferred.t
val connect_pool :
?max_size:int ->
?max_idle_size:int ->
?post_connect:
(connection -> (unit, 'connect_error) result Async_kernel.Deferred.t) ->
?env:(Caqti_driver_info.t -> string -> Caqti_query.t) ->
Uri.t ->
((connection, [> Caqti_error.connect ] as 'connect_error) Pool.t,
[> Caqti_error.load ])
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.