package caqti

  1. Overview
  2. No Docs
Unified interface to relational database libraries

Install 

dune-project
 Dependency

github.com Edit opam file Versions (21)

Authors

  1. P
    Petter A. Urkedal <paurkedal@gmail.com>
  2. N
    Nathan Rebours <nathan@cryptosense.com>
  3. B
    Basile Clément

Maintainers

  1. P
    Petter A. Urkedal <paurkedal@gmail.com>

Sources

caqti-v2.0.1.tbz
sha256=7eb57225c521fe25395653d960b1c381bb2b2ccae47bc2a827bb16611988da8b
sha512=eeafaf495b08fb8620ddee1711b8f9fa2ca0c79fb450a905c8d071806b7046d665e1e2ac0e7d3c7ca1258455decbf184e689e9ecb2453ec9d952b864f9dd14f4

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 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

Sourceval 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.

Sourceval 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.

Sourceval 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.