An unofficial FoundationDB client for Elixir.

FoundationDB is a distributed database designed to handle large volumes of structured data across clusters of commodity servers. It organises data as an ordered key-value store and employs ACID transactions for all operations. It is especially well-suited for read/write workloads but also has excellent performance for write-intensive workloads.

This documentation makes use of and refers to the upstream documentation where it makes sense.

Foundation

FDBC.Foundation is a wrapper around the database geared at easing use within applications.

defmodule Demo.Foundation do
  use FDBC.Foundation,
    otp_app: :demo,
    options: [
      transaction_retry_limit: 100,
      transaction_timeout: 60_000
    ]
end

Where the configuration for the Foundation must be in your application environment, usually defined in your config/config.exs:

config :demo, Demo.Foundation,
  cluster: "./fdb.cluster",
  directory: "demo"

If your application was generated with a supervisor you will have a lib/demo/application.ex file containing the application start callback that defines and starts your supervisor. You just need to edit the start/2 function to start the repo as a supervisor on your application's supervisor:

def start(_type, _args) do
  children = [
    Demo.Foundation,
  ]

  opts = [strategy: :one_for_one, name: Demo.Supervisor]
  Supervisor.start_link(children, opts)
end