package caqti
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=ba4dfd5ff94376b5e003f682410b7b3b392c0bbaa0253679fe7671c2e07e895b
sha512=0416807fba620429ee4d64f3a6991238112e0e10dfba9703dced46cf332fd22135a9873007d025441228ce66fb192bf730d4bc776dd2c1a973d7604ab6e789e0
doc/caqti.platform/Caqti_platform/Connector/Make/index.html
Module Connector.MakeSource
Constructs the main module used to connect to a database for the given concurrency model.
Parameters
module System : System_sig.Smodule Pool :
Pool.S
with type 'a fiber := 'a System.Fiber.t
and type switch := System.Switch.t
and type stdenv := System.stdenvmodule Loader :
Driver_loader.S
with type 'a fiber := 'a System.Fiber.t
and type switch := System.Switch.t
and type stdenv := System.stdenv
and type ('a, 'e) stream := ('a, 'e) System.Stream.tSignature
val connect :
?env:(Caqti_driver_info.t -> string -> Caqti_query.t) ->
?config:Caqti_connect_config.t ->
?tweaks_version:(int * int) ->
sw:System.Switch.t ->
stdenv:System.stdenv ->
Uri.t ->
((module Loader.CONNECTION), [> Caqti_error.load_or_connect ]) result
System.Fiber.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.
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:System.stdenv ->
Uri.t ->
((module Loader.CONNECTION) ->
('a, [> Caqti_error.load_or_connect ] as 'e) result System.Fiber.t) ->
('a, 'e) result System.Fiber.tval connect_pool :
?pool_config:Caqti_pool_config.t ->
?post_connect:
((module Loader.CONNECTION) ->
(unit, 'connect_error) result System.Fiber.t) ->
?env:(Caqti_driver_info.t -> string -> Caqti_query.t) ->
?config:Caqti_connect_config.t ->
?tweaks_version:(int * int) ->
sw:System.Switch.t ->
stdenv:System.stdenv ->
Uri.t ->
(((module Loader.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.