README

README.md

Synopsis

Caqti provides a monadic cooperative-threaded OCaml connector API for relational databases.

The purpose of Caqti is further to help make applications independent of a particular database system. This is achieved by defining a common signature, which is implemented by the database drivers. Connection parameters are specified as an URI, which is typically provided at run-time. Caqti then loads a driver which can handle the URI, and provides a first-class module which implements the driver API and additional convenience functionality.

Caqti does not generate or analyze SQL but provides templating and uniform query parameter handling, including encoding and decoding data according to declared types. It is hoped that this agnostic choice makes it a suitable target for higher level interfaces and code generators.

The following drivers are available:

The PGX based driver is experimental and only recommended for MirageOS. More about the drivers below.

Documentation

Tutorials and Examples

• Thecaqti-study repository is a tutorial with examples, which we will keep up to date with the latest release of Caqti. It is work in progress; suggestions and contributions are welcome.

• Interfacing OCaml and PostgreSQL with Caqti by Bobby Priambodo gives a gentle introduction, though the Caqti API has changed to some extend since it was written.

• The documented example in this repository can give a first idea.

API Documentation for Stable Releases

The stable API documentation is hosted onhttps://ocaml.org, where you can search package by name.

A full Caqti release contains the following packages:

• caqti: Core libraries and blocking unix connector.

• caqti-lwt: Lwt support library and connector.

• caqti-async: Async connector.

• caqti-eio: Experimental EIO connector.

• caqti-mirage: Experimental MirageOS connector.

• caqti-driver-mariadb: Driver for MariaDB and MySQL using C bindings frommariadb.

• caqti-driver-postgresql: Driver for PostgreSQL using C bindings frompostgresql.

• caqti-driver-sqlite3: Driver for local SQlite3 databases using C bindings fromsqlite3.

• caqti-driver-pgx: Experimental driver for PostgreSQL using thepgx library.

• caqti-tls: TLS configuration currently only used by caqti-mirage, and only relevant for pgx, since drivers based on C bindings have external TLS support.

The connector modules provide a connect functions which receives an URI, dispatches to an appropriate driver, and returns a connection object as a first-class module, which contains query functionality for the database. The application can either link against the drivers it needs or the link against thecaqti.plugin library in order to load the appropriate driver at runtime.

(A few package not mentioned include unreleased TLS packages and the semi-deprecated packagescaqti-type-calendar andcaqti-dynload.)

API Documentation for Development Snapshots

Apart from the above links, theGitHub pages are updated occasionally with a rendering from the master branch. You can also build the API reference matching your installed version usingodig or rundune build @doc in a Git checkout.

Running under utop

Dynamic linking does not work under utop. The workaround is to link against the needed database driver. E.g.

# #require "caqti-lwt";;# #require "caqti-driver-postgresql";;# open Lwt.Infix;;# open Caqti_request.Infix;;(* Create a DB handle. *)# module Db = (val Caqti_lwt_unix.connect (Uri.of_string "postgresql://") >>= Caqti_lwt.or_fail |> Lwt_main.run);;module Db : Caqti_lwt.CONNECTION(* Create a request which merely adds two parameters. *)# let plus = Caqti_request.(Caqti_type.(t2 int int) ->! Caqti_type.int) "SELECT ? + ?";;val plus : (int * int, int, [< `Many | `One | `Zero > `One ]) Caqti_request.t =  <abstr>(* Run it. *)# Db.find plus (7, 13);;- : (int, [> Caqti_error.call_or_retrieve ]) result = Ok 20

Related Software

• ppx_rapper - a syntax extension for Caqti queries, simplifying type specifications.

Sponsor

1. x509
2. uri>= "2.2.0"
3. tls
4. ptime
5. ocaml>= "4.08.0"
6. mtime>= "2.0.0"
7. lwt-dllist
8. logs
9. ipaddr>= "3.0.0"
10. dune-site
11. dune>= "3.9"
12. domain-name>= "0.2.0"
13. bigstringaf
14. angstrom>= "0.14.0"

1. rewith-test
2. odocwith-doc
3. cmdlinerwith-test & >= "1.1.0"
4. alcotestwith-test & >= "1.5.0"

1. builder-web>= "0.2.0"
2. caqti-async>= "2.1.1"
3. caqti-driver-mariadb>= "2.1.1"
4. caqti-driver-pgx>= "2.1.1"
5. caqti-driver-postgresql>= "2.1.1"
6. caqti-driver-sqlite3>= "2.1.1"
7. caqti-dynload>= "2.0.1"
8. caqti-eio>= "2.1.1"
9. caqti-lwt>= "2.1.1"
10. caqti-mirage>= "2.1.1"
11. caqti-tls
12. caqti-type-calendar>= "2.0.1"
13. dream>= "1.0.0~alpha6"
14. petrol

1. result< "1.5"