https://github.com/arenadotio/pgx

A pure OCaml PostgreSQL client library
https://github.com/arenadotio/pgx

ocaml postgresql

Last synced: 7 months ago
JSON representation

A pure OCaml PostgreSQL client library

• Host: GitHub
• URL: https://github.com/arenadotio/pgx
• Owner: arenadotio
• License: other
• Created: 2017-12-21T13:44:37.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2022-10-26T21:16:00.000Z (over 3 years ago)
• Last Synced: 2024-05-03T00:52:51.474Z (about 2 years ago)
• Topics: ocaml, postgresql
• Language: OCaml
• Size: 473 KB
• Stars: 121
• Watchers: 18
• Forks: 14
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-ocaml - pgx

README

          
[![CircleCI](https://circleci.com/gh/arenadotio/pgx.svg?style=shield)](https://circleci.com/gh/arenadotio/pgx)

[![Coverage Status](https://coveralls.io/repos/github/arenadotio/pgx/badge.svg?branch=master)](https://coveralls.io/github/arenadotio/pgx?branch=master)

[![Documentation](https://img.shields.io/badge/documentation-odoc-blue)](https://arenadotio.github.io/pgx/index.html)

PGX is a pure-OCaml PostgreSQL client library, supporting Async, LWT, or

synchronous operations.

This library focuses on correctness and safety, with features like:

 - It is nearly impossible to try to execute a prepared statement that hasn't

   been prepared.

 - Trying to run multiple queries at the same time will work properly (although

   there's no performance benefit, since we currently don't send queries in

   parallel).

 - Lots of automated tests.

 - `Pgx.Value` for parameters and returned data, encouraging people to use

   the built-in converters instead of trying to handle everything as a string.

 - Async and LWT support are built in, no need to write your own IO module.

 - Mirage OS is supported via Pgx_lwt_mirage

We also provide a relatively high-level interface, like `Pgx_async.execute_pipe`,

which prepares a statement, executes it with the given parameters, returns an

`Async.Pipe.Reader.t` (so you can stream results), and unprepares the statement

when the query is finished.

Significant portions of the code come from [PG'Ocaml](http://pgocaml.forge.ocamlcore.org/).

## Setup

```

opam install pgx_async # or pgx_lwt_unix or pgx_unix or pgx_lwt_mirage

```

## Examples

See [pgx_async/bin/pgx_async_example.ml](pgx_async/bin/pgx_async_example.ml) for

a complete example of the high-level functional interface. To translate the

example to Lwt, replace `Pgx_async` with `Pgx_lwt` and `>>|` with `>|=`. To

translate it to synchronous IO / standard-library-only, use `Pgx_unix` and

replace both `>>|` and `>>=` with `|>`, or just replace `>>| fun () ->` with `;`.

I.e. in `Pgx_unix`, you can replace:

```ocaml

Pgx_async.execute ~params "INSERT INTO ..."

>>| fun () ->

```

... with:

```ocaml

Pgx_unix.execute ~params "INSERT INTO ...";

```