package caqti

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

Install 

dune-project
 Dependency

github.com Edit opam file Versions (24)

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.3.2.tbz
sha256=8f6c1724b59ac22a5c657c9e53b9a1706e39ecd462e82958b0cea88e43f0aba7
sha512=75b968ab37ae94cadcaabbcce0f91b1ffa4334ed69e441bdeb823077eb7675264282efb0fab3baaaad446582cfb427769e19f22c8c194a316ac2248c3fba5cf8

doc/caqti.template/Caqti_template/Version/index.html

Module Caqti_template.VersionSource

Opaque version strings with comparison.

This version number module is intended for dispatching on details about an SQL intepreter or other relevant aspects of a relational database system. The only constructor is private, instead the Infix module provides direct comparison to strings for ideomatic usage in the query-returning callback of request templates.

Some care is needed to match ranges of versions correctly:

  • A version provided by Dialect may by unknown. An unknown version compares like the empty string, meaning that it compares before any other (sensible) version. If another logic is desired, is_known can be used to distinugish it.
  • A version provided by Dialect may also include build numbers, distribution details, etc. Therefore it seldom makes sense to compare it agains the exact version of the software release. Such versions will instead compare between the version of the corresponding software release and the next possible version using a normal decimal-dotted versioning scheme.
Sourcetype t
Sourceval is_known : t -> bool

Tests whether a version from the database server is available.

Sourceval compare : t -> t -> int

Compares two versions lexicographically group-by-group and component-by-component, using common conventions for comparing version numbers:

  • Groups of components are separated by '-'.
  • Components are separated by '.'.
  • Continuous sequences of digits are compared numerically, i.e. after skipping leading zeros, longer such sequences compare after shorter ones.
  • '~' compares before anything else, including the empty suffix.

The ordering subject to change if we should encounter problematic differences with versioning schemes used by supported database systems.

Sourceval equal : t -> t -> bool

equal x y is equivalent to compare x y = 0.

Sourcemodule Infix : sig ... end

Asymmetric infix oparator for testing version ranges. The first argument is a version number, typically obtained from the server_version fields of Dialect.t, and the second argument is a string representation of the version to compare against.

Sourceval pp : Format.formatter -> t -> unit