commit | 956920ec44c9e0aca4ea3d2bd71f2bec290a1abf | [log] [tgz] |
---|---|---|
author | Adam Kocoloski <kocolosk@apache.org> | Wed Nov 03 16:55:13 2021 -0400 |
committer | GitHub <noreply@github.com> | Wed Nov 03 16:55:13 2021 -0400 |
tree | 7c0d1c736d579c89d993c9f04492c9fcf12f96a8 | |
parent | 818777328c5fbebb331fd9c69b1095b172ed8397 [diff] |
Make dialyzer happy (#32) * Update a couple of type specs to match reality * Remove dead code
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
FoundationDB has a custom binding tester that can be used to test whether changes have broken compatibility. See the BINDING_TESTER documentation for instructions on building and running that system.