package caqti

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

Install 

dune-project
 Dependency

github.com Readme Changelog 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.2.4.tbz
sha256=b8ea432820154ec095132c4f7b244b06cd8553e0b2035185b844d9c4f30af8bb
sha512=b7e3ad8e6a9b587db2d517e15cd42df2945148f9223b2fa6f4bc2bcdd2709d53549cca4b65e54511d22466e4c9aa7f0b9c17305a07505519d8bf81d95de629b8

doc/caqti.platform/Caqti_platform/Request_cache/Make/index.html

Module Request_cache.MakeSource

Parameters

module Elt : Lru.Weighted

Signature

Sourcetype elt = Elt.t
Sourcetype t
Sourceval create : ?dynamic_capacity:int -> Caqti_template.Dialect.t -> t

create dialect creates a cache of prepared queries for requests specialized for dialect.

  • parameter dynamic_capacity

    is the sum weight of elements of the LRU used for dynamic requests below which trim will not attempt to release anything.

Sourceval find_and_promote : t -> ('a, 'b, 'm) Caqti_template.Request.t -> elt option

find_and_promote cache request promotes and returns the data associated with request in cache, if any.

Sourceval add : t -> ('a, 'b, 'm) Caqti_template.Request.t -> elt -> unit

Given the hard precondition that request is not bound in cache, as verified by find_and_promote, add cache request data binds it to data.

Sourceval remove_and_discard : t -> ('a, 'b, 'm) Caqti_template.Request.t -> unit

remove_and_discard cache request removes the binding for request from cache. The caller is assumed to have just extracted the element with find_and_promote and is resposible for releasing related resources.

Sourceval deallocate : t -> ('a, 'b, 'm) Caqti_template.Request.t -> (elt * (unit -> unit)) option

deallocate request returns the entry for request, if any, along with a function to remove it from the cache.

Sourceval iter : (elt -> unit) -> t -> unit

iter f cache calls f on each element of cache.

Sourceval elements : t -> elt list

elements cache is an arbitrarily ordered list of all elements, whether associated with a static or dynamic request.

Sourceval trim : ?max_promote_count:int -> t -> elt list * (unit -> unit)

trim ?promote_count cache carrious out some work trimming elements from the dynamic LRU cache. The call promotes up to max_promote_count elements, which are alive according to the garbage collector, and stop at the next one. It is up to the caller to free any resources associated with the returned elements.

Sourceval clear_and_discard : t -> unit

clear cache removes all entries form cache. Elements are not returned, since this function may be used after a connection reset which invalidates the cached resources, but can be requested by calling elements first.

Sourceval dynamic_weight : t -> int