All Projects → paurkedal → Ocaml Caqti

paurkedal / Ocaml Caqti

Licence: other
Cooperative-threaded access to relational data

Programming Languages

ocaml
1615 projects

Projects that are alternatives of or similar to Ocaml Caqti

Sqlx
🧰 The Rust SQL Toolkit. An async, pure Rust SQL crate featuring compile-time checked queries without a DSL. Supports PostgreSQL, MySQL, SQLite, and MSSQL.
Stars: ✭ 5,039 (+2779.43%)
Mutual labels:  async, postgresql, sqlite, mariadb
Dbbench
🏋️ dbbench is a simple database benchmarking tool which supports several databases and own scripts
Stars: ✭ 52 (-70.29%)
Mutual labels:  database, postgresql, sqlite, mariadb
Prisma
Next-generation ORM for Node.js & TypeScript | PostgreSQL, MySQL, MariaDB, SQL Server, SQLite & MongoDB (Preview)
Stars: ✭ 18,168 (+10281.71%)
Mutual labels:  database, postgresql, mariadb, sqlite
Evolve
Database migration tool for .NET and .NET Core projects. Inspired by Flyway.
Stars: ✭ 477 (+172.57%)
Mutual labels:  database, postgresql, sqlite, mariadb
Phpmyfaq
phpMyFAQ - Open Source FAQ web application for PHP and MySQL, PostgreSQL and other databases
Stars: ✭ 494 (+182.29%)
Mutual labels:  database, postgresql, sqlite, mariadb
Typeorm
ORM for TypeScript and JavaScript (ES7, ES6, ES5). Supports MySQL, PostgreSQL, MariaDB, SQLite, MS SQL Server, Oracle, SAP Hana, WebSQL databases. Works in NodeJS, Browser, Ionic, Cordova and Electron platforms.
Stars: ✭ 26,559 (+15076.57%)
Mutual labels:  database, postgresql, sqlite, mariadb
Denodb
MySQL, SQLite, MariaDB, PostgreSQL and MongoDB ORM for Deno
Stars: ✭ 498 (+184.57%)
Mutual labels:  database, postgresql, sqlite, mariadb
Linq2db
Linq to database provider.
Stars: ✭ 2,211 (+1163.43%)
Mutual labels:  database, postgresql, sqlite, mariadb
Tortoise Orm
Familiar asyncio ORM for python, built with relations in mind
Stars: ✭ 2,558 (+1361.71%)
Mutual labels:  async, postgresql, sqlite
Dbmigrations
A library for the creation, management, and installation of schema updates for relational databases.
Stars: ✭ 67 (-61.71%)
Mutual labels:  database, postgresql, sqlite
Ebean
Ebean ORM
Stars: ✭ 1,172 (+569.71%)
Mutual labels:  database, sqlite, mariadb
Hunt Entity
An object-relational mapping (ORM) framework for D language (Similar to JPA / Doctrine), support PostgreSQL and MySQL.
Stars: ✭ 51 (-70.86%)
Mutual labels:  database, postgresql, sqlite
Goqu
SQL builder and query library for golang
Stars: ✭ 984 (+462.29%)
Mutual labels:  database, postgresql, sqlite
Tbls
tbls is a CI-Friendly tool for document a database, written in Go.
Stars: ✭ 940 (+437.14%)
Mutual labels:  postgresql, sqlite, mariadb
Entityworker.core
EntityWorker is an object-relation mapper(ORM) that enable .NET developers to work with relations data using objects. EntityWorker is an alternative to entityframwork. is more flexible and much faster than entity framework.
Stars: ✭ 91 (-48%)
Mutual labels:  database, postgresql, sqlite
Bookshelf
A simple Node.js ORM for PostgreSQL, MySQL and SQLite3 built on top of Knex.js
Stars: ✭ 6,252 (+3472.57%)
Mutual labels:  database, postgresql, sqlite
Electrocrud
Database CRUD Application Built on Electron | MySQL, Postgres, SQLite
Stars: ✭ 1,267 (+624%)
Mutual labels:  database, postgresql, sqlite
Qtl
A friendly and lightweight C++ database library for MySQL, PostgreSQL, SQLite and ODBC.
Stars: ✭ 92 (-47.43%)
Mutual labels:  database, postgresql, sqlite
Kangaroo
SQL client and admin tool for popular databases
Stars: ✭ 127 (-27.43%)
Mutual labels:  database, postgresql, sqlite
Directus
Open-Source Data Platform 🐰 — Directus wraps any SQL database with a real-time GraphQL+REST API and an intuitive app for non-technical users.
Stars: ✭ 13,190 (+7437.14%)
Mutual labels:  database, postgresql, sqlite

CircleCI

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 make assumptions about the structure of the query language, and only provides the type information needed at the edges of communication between the OCaml code and the database; i.e. for encoding parameters and decoding returned tuples. It is hoped that this agnostic choice makes it a suitable target for higher level interfaces and code generators.

Drivers

The following drivers are available.

  • MariaDB (mariadb://)
    • Implemented in terms of ocaml-mariadb using asynchronous calls.
    • Supports transactions.
    • Pools connections and caches statements.
  • PostgreSQL (postgresql://)
    • Implemented in terms of postgresql-ocaml using asynchronous calls.
    • Supports transactions.
    • Pools connections and caches statements.
  • SQLite3 (sqlite3://)
    • Implemented in terms of sqlite3-ocaml using preemtive threading for non-blocking operation.
    • Supports transactions.
    • Does not pool connections but caches statements.

If you link against caqti-dynload, then drivers are loaded dynamically based on the URI. If dynamic loading is unavailable on your platform, you may instead link against the caqti-driver-* libraries which you expect to use.

Documentation

For a gentle introduction I recommend reading Interfacing OCaml and PostgreSQL with Caqti by Bobby Priambodo. There is also a documented example in this repository.

A recent rendering of the full API reference is available online. You can also generate the API reference matching your installed version using odig. Finally, topkg doc builds the reference from a Git checkout using topkg-care.

As the main entry point, you would normally use either of

Caqti_lwt : Caqti_connect_sig.S with type 'a future := 'a Lwt.t
Caqti_async : Caqti_connect_sig.S with type 'a future := 'a Deferred.t
Caqti_blocking : Caqti_connect_sig.S with type 'a future = 'a

provided by caqti-lwt, caqti-async, and caqti.blocking, respectively. These provide a connect functions which receives an URI, loads the appropriate driver, and returns a connection as a first-class module containing query functionality for the database.

The most important modules to know about are:

  • Caqti_type and Caqti_request for constructing prepared or one-shot queries.
  • Caqti_lwt, Caqti_async, and Caqti_blocking for connecting to the database and obtaining a first class module implementing Caqti_connection_sig.S.
  • Caqti_connection_sig.S and Caqti_response_sig.S for executing queries.

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;;

(* Create a DB handle. *)
# module Db = (val Caqti_lwt.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.find Caqti_type.(tup2 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/PostgreSQL queries
Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].