package caqti
Install
dune-project
Dependency
Authors
Maintainers
Sources
sha256=4dadf33904c9fd25065dbf6739aa0a9eaaaea000c6981c17a534b475dd5c3891
sha512=13c1cbeff3ee0e54ed1cc8f8df5f7660c292d5d50faa9480916f3c7e578961ab3b3779395c0664346cf42509f7b98d986e8377133542869a462288d6c0e34cbf
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 :
?subst:(Caqti_template.Dialect.t -> Caqti_template.Query.subst) ->
?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.plugin package.
val with_connection :
?subst:(Caqti_template.Dialect.t -> Caqti_template.Query.subst) ->
?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) ->
?subst:(Caqti_template.Dialect.t -> Caqti_template.Query.subst) ->
?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.