foundationdb/README.md

FoundationDB

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.

Building Locally

macOS

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.

Linux

1. Install [Docker] (https://www.docker.com/).
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] (https://docs.docker.com/engine/reference/run/#general-form) with the directory containing the foundationdb repo mounted [Docker Mounts] (https://docs.docker.com/storage/volumes/). 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.