Jay Taylor's notes

back to listing index


[web search]
Original source (github.com)
Tags: database distributed-systems sql apple foundationdb github.com
Clipped on: 2018-04-19
FoundationDB - the open source, distributed, transactional key-value store https://www.foundationdb.org
C++ C Java Python Go C# Other
FDBLibTLS change file name within comment to be, like, the correct name an hour ago
bindings Merge remote-tracking branch 'upstream/release-5.1' into release-5.2-… 30 minutes ago
build Add an -fPIC build of libressl to the build image. 7 days ago
design Backup design documentation. 2 months ago
documentation Merge remote-tracking branch 'upstream/release-5.2' into master-5.2-m… 25 minutes ago
fdbbackup remove trailing whitespace from our copyright headers ; fixed formatt… 2 months ago
fdbcli Merge remote-tracking branch 'upstream/release-5.2' into merge-releas… 8 days ago
fdbclient Merge pull request #182 from alecgrieser/merge-release-5.2 an hour ago
fdbmonitor remove trailing whitespace from our copyright headers ; fixed formatt… 2 months ago
fdbrpc Merge branch 'release-5.2' 2 days ago
fdbserver Merge branch 'release-5.2' 14 hours ago
fdbservice Remove references to unused project 7 days ago
flow Merge branch 'release-5.2' 9 days ago
layers remove trailing whitespace from our copyright headers ; fixed formatt… 2 months ago
packaging updated versions.target for 5.1.8 15 hours ago
recipes bump API version to 520 2 months ago
tests Merge branch 'release-5.2' 9 days ago
.gitignore Merge pull request #125 from brownleej/go-doc-build-removal 6 days ago
ACKNOWLEDGEMENTS Initial repository commit 11 months ago
CODE_OF_CONDUCT.md Updates markdown link to Contributor Covenant homepage in the Code of… 2 days ago
CONTRIBUTING.md Adds initial draft of contribution guide. 7 days ago
LICENSE Initial repository commit 11 months ago
Makefile Merge pull request #151 from alexmiller-apple/tlsplugin51 6 days ago
README.md Remove horizontal rule 19 hours ago
foundationdb.sln removed references to nodejs bindings 13 days ago
versions.target Updated Version to 6.0 2 months ago


FoundationDB is a distributed database designed to handle large volumes of structured data across clusters of commodity servers. It organizes 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. Users interact with the database using API language binding.

To learn more about FoundationDB, visit foundationdb.org


Documentation can be found online at https://apple.github.io/foundationdb/. The documentation covers details of API usage, background information on design philosophy, and extensive usage examples. Docs are built from the source in this repo.


The FoundationDB Forums are the home for most of the discussion and communication about the FoundationDB project. We welcome your participation! We want FoundationDB to be a great project to be a part of and, as part of that, have established a Code of Conduct to establish what constitutes permissible modes of interaction.


Contributing to FoundationDB can be in contributions to the code base, sharing your experience and insights in the community on the Forums, or contributing to projects that make use of FoundationDB. Please see the contributing guide for more specifics.

Getting Started

Binary downloads

Developers interested in using the FoundationDB store for an application can get started easily by downloading and installing a binary package. Please see the downloads page for a list of available packages.

Compiling from source

Developers on a OS for which there is no binary package, or who would like to start hacking on the code can get started by compiling from source.


  1. Check out this repo on your Mac.
  2. Install the Xcode command-line tools.
  3. Download version 1.52 of Boost.
  4. Set the BOOSTDIR environment variable to the location containing this boost installation.
  5. Install Mono.
  6. Install a JDK. FoundationDB currently builds with Java 8.
  7. Navigate to the directory where you checked out the foundationdb repo.
  8. Run make.


  1. Install Docker.
  2. Build Linux docker image using the file Dockerfile located in the build source directory.
  3. Check out the foundationdb repo.
  4. Run the docker image interactively Docker Run with the directory containing the foundationdb repo mounted Docker Mounts. docker run -it -v '/local/dir/path/foundationdb:/docker/dir/path/foundationdb' /bin/bash
  5. Navigate to the mounted directory containing the foundationdb repo. cd /docker/dir/path/foundationdb
  6. Run make.

This will build the fdbserver binary and the python bindings. If you want to build our other bindings, you will need to install a runtime for the language whose binding you want to build. Each binding has an .mk file which provides specific targets for that binding.

Press h to open a hovercard with more details.