package caqti-async

  1. Overview
  2. Docs
Async support for Caqti

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (10)

Authors

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

Maintainers

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

Sources

caqti-v1.3.0.tbz
sha256=a15d71b6428997703273dc6d55a99045fb62c3243c751de5ae8c3fc25421f16a
sha512=386502d9ea2f1769081b81e6888bf4c2a27248498eabc0d4eb4adfde04c74f48f2aa587c0ce3a34604c73d157ed6533052b4d0b9a0fb3f352929ef847f3aa9fa

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

A pool implementation for the current concurrency library.

Sourcemodule type CONNECTION = Caqti_connection_sig.S with type 'a future := 'a Async_kernel.Deferred.t and type ('a, 'err) stream := ('a, 'err) Stream.t

The connection API specialized for the current concurrency library.

Sourcetype connection = (module CONNECTION)

Shortcut for the connection API passed as a value.

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.

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.

Sourceval connect_pool : ?max_size:int -> ?max_idle_size:int -> ?post_connect: (connection -> (unit, 'connect_error) result Async_kernel.Deferred.t) -> Uri.t -> ((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 max_size

    The maximum number of open connections. Must be at least 1. For drivers which does not support concurrent connections, this will be ignored and the value 1 used instead.

  • parameter max_idle_size

    The maximum number of idle connections to put into the pool for reuse. Defaults to max_size. Must be between 0 and max_size. If you set this, you must also set max_size. For drivers which does not support pooling, this will be ignored and the value 0 used instead. For drivers which does not support concurrent connections, but supports pooling, the value will clipped to a maximum of 1.