| commit | 53077693e161368f6c33b73a2f967fe490c36838 | [log] [tgz] |
|---|---|---|
| author | Nick Vatamaniuc <vatamane@apache.org> | Thu Mar 25 18:42:18 2021 -0400 |
| committer | Nick Vatamaniuc <nickva@users.noreply.github.com> | Thu Mar 25 20:58:39 2021 -0400 |
| tree | 33516ac462c0649f9d272e6b5ebcd77db3940810 | |
| parent | 1314c2ac70bb3f87ed6694a5d3751b26b9c885d4 [diff] |
Add ERLFDB_IS_RETRYABLE/2 guard This is a guard which may be used to catch and handle retryable errors. It's more ergonomic as a guard than a function, since the handler won't have to catch and re-throw unwanted (non-retryable) exceptions. Along with a guard, some common FDB error codes are also defined. It's not an exhaustive list and mostly consists of retryable and a few other common errors.
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.