package caqti

You can search for identifiers within the package.

in-package search v0.2.0

Unified interface to relational database libraries

Install

Dune Dependency

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

Authors

Maintainers

P

Petter A. Urkedal <paurkedal@gmail.com>

Sources

caqti-v1.4.0.tbz

sha256=9501f0bed11ae4c134824a1cfd2072614de46d56ee30c84245c040ef53e9dc46

sha512=56bfd42ab4f85d369b3a317047d8172172239ee7b2989b2b9c4a8d39349c5bd504cca54180a526c23486613ebe57c89f8be143007f6873089dc7d48bd03267f1

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

Module `Caqti_blocking.Pool`

A pool implementation for the current concurrency library.

Sourcetype ('a, +'e) t

Source

val create : 
  ?max_size:int ->
  ?max_idle_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 intended for implementing the connect_pool functions.

parameter max_size
The maximum number of allocated resources.

parameter max_idle_size
The maximum number of resources to pool for later use. Defaults to max_size.

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.

Source

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