commit | 055be31930a0796b2a49f3e6389db66d33c6844f | [log] [tgz] |
---|---|---|
author | Paul J. Davis <paul.joseph.davis@gmail.com> | Wed Sep 25 10:44:20 2019 -0500 |
committer | Paul J. Davis <paul.joseph.davis@gmail.com> | Wed Sep 25 10:44:20 2019 -0500 |
tree | e522362b087f30053a324bdd2a324ee7d8d13ada | |
parent | d03c5d2a5f6c873bf6e1f04d3b8090d4694197c3 [diff] |
Adding a better README
This project is a NIF wrapper for the FoundationDB C API. Documentation on the main API can be found here.
This project also provides a conforming implementation of the Tuple and Directory layers.
Assuming you have installed the FoundationDB C API library, building erlfdb is as simple as:
$ make
Alternatively, adding erlfdb as a rebar dependency should Just Work ®.
Documentation for installing FoundationDB can be found here for macOS or here for Linux.
A simple example showing how to open a database and read and write keys:
Eshell V9.3.3.6 (abort with ^G) 1> Db = erlfdb:open(<<"/usr/local/etc/foundationdb/fdb.cluster">>). {erlfdb_database,#Ref<0.2859661758.3941466120.85406>} 2> ok = erlfdb:set(Db, <<"foo">>, <<"bar">>). ok 3> erlfdb:get(Db, <<"foo">>). <<"bar">> 4> erlfdb:get(Db, <<"bar">>). not_found