package caqti

  1. Overview
  2. Docs
package caqti
Legend:
Library
Module
Module type
Parameter
Class
Class type

Constructs the main module used to connect to a database for the given concurrency model.

Parameters

module Pool : Pool.S with type 'a fiber := 'a System.Fiber.t and type switch := System.Switch.t and type stdenv := System.stdenv
module 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.t

Signature

val connect : ?env:(Caqti_driver_info.t -> string -> Caqti_query.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.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.

See Database Tweaks for details about the tweaks_version parameter.

  • parameter tweaks_version

    Declares compatibility with database tweaks introduced up to the given version of Caqti. Defaults to a conservative value. See the above reference for more info (not linked here due to odoc issue).

  • parameter env

    If provided, this function will do a final expansion of environment variables which occurs in the query templates of the requests executed on the connection.

val with_connection : ?env:(Caqti_driver_info.t -> string -> Caqti_query.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.t

with_connection uri f calls connect on uri. If connect evaluates to Ok connection, with_connection passes the connection to f. Once f either evaluates to a result, or raises an exception, with_connection closes the database connection.

  • parameter tweaks_version

    Passed to connect.

val 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) -> ?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 ]) 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.

  • parameter tweaks_version

    Passed to connect when creating new connections.

  • parameter env

    Passed to connect when creating new connections.

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct