View Source An Erlang Binding to FoundationDB

CI

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.

The original development of this project occurred as apache/couchdb-erlfdb. This fork was created in early 2024 to continue development of the project.

Building

Assuming you have installed the FoundationDB C API library, building erlfdb is as simple as:

$ rebar3 compile

Alternatively, adding erlfdb as a rebar dependency should Just Work ®.

Documentation for installing FoundationDB can be found here for macOS or here for Linux.

Bypassing dependency checks

When you execute a rebar command, erlfdb attempts to detect the version of the fdbcli installed on your system. If it cannot be detected, the rebar command is aborted.

To disable the abort, use ERLFDB_ASSERT_FDBCLI=0. For example, you can safely use this for the fmt command, which does not do a compile action.

ERLFDB_ASSERT_FDBCLI=0 rebar3 fmt

Quick Example

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

Binding Tester

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.