package caqti-async
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=e1f580848faf3a54f23174067f2c75f77f6a2fe50ca8bc923428d0e1841192c5
sha512=7a11edfcfbbe4855347b066e222cf6bf46d1afedcd4978661b9a2b3931921faa1768a6bc24031fd3afa84537fe2adc8b139399deb77120461bee8fb394d68e82
doc/caqti-async/Caqti_async/index.html
Module Caqti_asyncSource
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.tA pool implementation for the current concurrency library.
module Stream :
Caqti_stream.S with type 'a future := 'a Async_kernel.Deferred.tmodule type CONNECTION =
Caqti_connection_sig.S
with type 'a future := 'a Async_kernel.Deferred.t
and type ('a, 'err) stream := ('a, 'err) Stream.tThe connection API specialized for the current concurrency library.
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 ]) result Async_kernel.Deferred.tconnect 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 Async_kernel.Deferred.t) ->
('a, 'e) result Async_kernel.Deferred.tval connect_pool :
?max_size:int ->
?max_idle_size:int ->
?max_use_count:int option ->
?post_connect:
(connection -> (unit, 'connect_error) result Async_kernel.Deferred.t) ->
?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.