Go to file
Evan Tschannen c757c68bfa fix: nextVersion needs to be set to logData->version if version_sizes is empty 2018-08-04 23:53:37 -07:00
FDBLibTLS call all methods which could disable a trace event before it is initialized. In practice this means calling .error first, then .suppressFor, then all your details. 2018-08-01 14:30:57 -07:00
bindings Merge remote-tracking branch 'upstream/release-5.2' into release-6.0-5.2-merge 2018-07-31 13:17:37 -07:00
build Move TLS libs into STATIC_LIBS to avoid having a make dependency on them. 2018-07-04 00:29:53 -07:00
design Backup design documentation. 2018-02-22 18:09:41 -08:00
documentation Update 6.0 release notes as well as 5.2 old release notes. 2018-08-03 10:46:21 -07:00
fdbbackup Fix not depending on FDBLibTLS.a and default TLS_LIBDIR to a sensible place. 2018-07-05 13:23:20 -07:00
fdbcli call all methods which could disable a trace event before it is initialized. In practice this means calling .error first, then .suppressFor, then all your details. 2018-08-01 14:30:57 -07:00
fdbclient Merge branch 'release-5.2' into release-6.0 2018-08-02 11:29:40 -07:00
fdbmonitor fix fdbmonitor help message output ; fix spelling error Ratekeeper.actor.cpp 2018-05-07 16:19:50 -07:00
fdbrpc Merge branch 'release-5.2' into release-6.0 2018-08-03 11:40:24 -07:00
fdbserver fix: nextVersion needs to be set to logData->version if version_sizes is empty 2018-08-04 23:53:37 -07:00
fdbservice Fix typo: orginal > original 2018-04-20 17:29:13 +09:00
flow tlogs serve reads to log routers at a low priority, to prevent them from using all their resources catching up a remote dc that has been down for a long time 2018-08-04 10:31:30 -07:00
layers remove trailing whitespace from our copyright headers ; fixed formatting of python setup.py 2018-02-21 10:25:11 -08:00
packaging updated versions.target and wix UID 2018-08-02 19:33:32 -07:00
recipes bump API version from 520 to 600 2018-07-09 11:00:57 -07:00
tests added the connection string to status 2018-07-09 22:11:58 -07:00
.clang-format Add a clang-format config file. 2018-03-29 12:10:12 -07:00
.gitignore Exclude .vs folder (Visual Studio 2017) 2018-05-12 15:20:52 +02:00
ACKNOWLEDGEMENTS Initial repository commit 2017-05-25 13:48:44 -07:00
CODE_OF_CONDUCT.md Updates markdown link to Contributor Covenant homepage in the Code of Conduct. 2018-04-18 01:08:55 -04:00
CONTRIBUTING.md Adds initial draft of contribution guide. 2018-04-12 17:59:32 -07:00
LICENSE Initial repository commit 2017-05-25 13:48:44 -07:00
Makefile Fix not depending on FDBLibTLS.a and default TLS_LIBDIR to a sensible place. 2018-07-05 13:23:20 -07:00
README.md Update Linux compilation instructions 2018-04-23 14:43:09 +01:00
foundationdb.sln removed references to nodejs bindings 2018-04-06 17:17:45 -07:00
versions.target updated versions.target and wix UID 2018-08-02 19:33:32 -07:00

README.md

FoundationDB logo

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

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.

Forums

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

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.

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.
  2. Check out the foundationdb repo.
  3. Build Linux docker image using the file Dockerfile located in the build source directory.
  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.