package caqti

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

Install

Dune Dependency

Authors

Maintainers

Sources

caqti-v1.2.1.tbz
sha256=8622429654c374774a637d5434182863800bafa1dcc86ddded3ff24a86a55e44
sha512=5dd1398bd0b2ee21d1dead6a6dc07a35c8ec72e738f0cc3add1f1846f8ea73a0e19c8cd99e316f8e752d020aac396265d0da5d331d9c21bdcb61b8a5266e7b5d

doc/caqti.blocking/Caqti_blocking/Pool/index.html

Module Caqti_blocking.Pool

A pool implementation for the current concurrency library.

Sourcetype ('a, +'e) t
Sourceval create : ?max_size:int -> ?check:('a -> (bool -> unit) -> unit) -> ?validate:('a -> bool future) -> (unit -> ('a, 'e) result future) -> ('a -> unit future) -> ('a, 'e) t

Internal: create alloc free is a pool of resources allocated by alloc and freed by free. This is primarily indented for implementing the connect_pool functions.

  • parameter max_size

    Maximum number of resources to allocate at any given time.

  • parameter check

    A function used to check a resource after use.

  • parameter validate

    A function to check before use that a resource is still valid.

Sourceval size : ('a, 'e) t -> int

size pool is the current number of open resources in pool.

Sourceval use : ?priority:float -> ('a -> ('b, 'e) result future) -> ('a, 'e) t -> ('b, 'e) result future

use f pool calls f on a resource drawn from pool, handing back the resource to the pool when f exits.

  • parameter priority

    Requests for the resource are handled in decreasing order of priority. The default priority is 0.0.

Sourceval drain : ('a, 'e) t -> unit future

drain pool closes all resources in pool. The pool is still usable, as new resources will be created on demand.

OCaml

Innovation. Community. Security.