1
1
[ ![ CircleCI] ( https://circleci.com/gh/arenadotio/pgx.svg?style=shield )] ( https://circleci.com/gh/arenadotio/pgx )
2
2
[ ![ Coverage Status] ( https://coveralls.io/repos/github/arenadotio/pgx/badge.svg?branch=master )] ( https://coveralls.io/github/arenadotio/pgx?branch=master )
3
+ [ ![ Documentation] ( https://img.shields.io/badge/documentation-odoc-blue )] ( https://arenadotio.github.io/pgx/index.html )
3
4
4
5
PGX is a pure-OCaml PostgreSQL client library, supporting Async, LWT, or
5
6
synchronous operations.
6
7
7
- [ API documentation] ( https://arenadotio.github.io/pgx/doc/ )
8
-
9
- ** This is an early release. The API is likely to change significantly before
10
- the 1.0 release.**
11
-
12
8
This library focuses on correctness and safety, with features like:
13
9
14
10
- It is nearly impossible to try to execute a prepared statement that hasn't
@@ -20,6 +16,7 @@ This library focuses on correctness and safety, with features like:
20
16
- ` Pgx.Value ` for parameters and returned data, encouraging people to use
21
17
the built-in converters instead of trying to handle everything as a string.
22
18
- Async and LWT support are built in, no need to write your own IO module.
19
+ - Mirage OS is supported via Pgx_lwt_mirage
23
20
24
21
We also provide a relatively high-level interface, like ` Pgx_async.execute_pipe ` ,
25
22
which prepares a statement, executes it with the given parameters, returns an
@@ -31,7 +28,7 @@ Significant portions of the code come from [PG'Ocaml](http://pgocaml.forge.ocaml
31
28
## Setup
32
29
33
30
```
34
- opam pin add pgx https://github.com/arenadotio/pgx.git
31
+ opam install pgx_async # or pgx_lwt_unix or pgx_unix or pgx_lwt_mirage
35
32
```
36
33
37
34
## Examples
0 commit comments