fdb v5.1.7-5 API Reference

Modules

This module provides functions to initialize the library. Note that the functions in this module should be called only once

This module provides functions to create and configure cluster

A FDB.Coder.t/0 specifies how any value should be encoded before storing it in server and how it should be decoded when it’s retrieved from the server. A custom coder can be created by implementing the FDB.Coder.Behaviour behaviour

Refer modules named FDB.Coder.* for sample implementation

Note that implementation of Float is not fully compatible with the spec. It uses the erlang floating point implementation which is not fully compatible with the IEEE Binary Floating Point spec. It doesn’t supports values like NaN, Infinity etc. As long as these values are not used by other language bindings this coder would work

Supports integer in the range -0xFFFFFFFFFFFFFFFF..0xFFFFFFFFFFFFFFFF (8 bytes). Consider using FDB.Coder.ArbitraryInteger for arbitrary precision numbers

This should be only used at the top level. For nested tuple FDB.Coder.NestedTuple should be used

This module provides functions to create and configure database and functions to do transactions on database

Directory is one of the ways to manage namespaces

A FDB.Future.t/0 represents the result of an async operation

Refer KeySelector section for the semantics. A partial or prefix key could refer to multiple keys in the database. The prefix option controls whether it should be resolved to the first or last key with the given prefix

FoundationDB C API uses event loop architecture. All the network io operations are handled by a singleton network thread. This module provides functions to configure, start and stop the network thread. The functions should be called in the order given below

This module contains all the options that are accepted by various functions. These options are autogenerated from xml file

A FDB.Transaction.Coder.t/0 specifies how the key and value should be encoded

Exceptions