Skip to content

Latest commit

 

History

History
233 lines (165 loc) · 8.6 KB

README.md

File metadata and controls

233 lines (165 loc) · 8.6 KB
Raw

ReFound

This implements RethinkDB's query language as a stateless layer in front of FoundationDB. Forked from RethinkDB, this is a precise (but not complete) implementation meant as a drop-in replacement.

To build, install the FoundationDB client libraries onto your system (e.g. your Linux system) and then use the usual RethinkDB ./configure --allow-fetch and make -j8 commands.

Useful commands:

# Connects to an empty FoundationDB instance and sets up a
# RethinkDB instance in that FoundationDB cluster.  Also,
# initializes the local metadata directory (with `cluster_id` and
# `log_file` files).

rethinkdb create --fdb-init
rethinkdb create --fdb-init --fdb-force-wipe

# Connects to existing FoundationDB instance (that was initialized
# with `--fdb-init`) and initializes the local metadata directory.

rethinkdb create

# `serve` then acts as a quasi-stateless node once the local
# metadata directory has been created.

rethinkdb serve

These expect you to have a FoundationDB instance running and a FoundationDB configuration file in the default system location. You may also pass --fdb-cluster-file file, or you may put an fdb.cluster file into the data directory before creation:

mkdir path/to/datadir
cp my_fdb.cluster path/to/datadir/fdb.cluster
rethinkdb create -d path/to/datadir

The nodes are "stateless." The data directory contains log_file, a cluster_id file to prevent mistakenly reconnecting to the wrong cluster, and a node_id file, which is used to reuse the same node id upon restart, which allows background jobs to be restarted more quickly.

This repo is up to date with RethinkDB 2.4.4. It is forked off of RethinkDB 2.4.x, at some point after 2.4.2 and cherry-picks in its most recent changes.

Missing Features/Differences

Your code will encounter straightforward errors if you use:

  • change feeds
  • shard configuration commands (which are inapplicable), or
  • rows larger than 9 megabytes

You might get less straightforward errors if you use:

  • system tables (some data is inapplicable, faked for compatibility, or missing),

Change feeds and arbitrarily large documents could be implemented, if there is demand.

Technical Notes

This does have some basics you'd hope any record store to have:

  • table configuration caching and optimistic (late-failing) configuration version checking

  • background index building

  • automatic background job failover

The only background jobs are index building and mass table deletion.

Index building is over-engineered, over-generalized, to avoid starvation while supporting new types of indexes that are not present in RethinkDB and have not been implemented.

The implementation effort was mostly oriented towards minimizing developer time and technical risk. Thus the code still has some old RethinkDB cruft, such as its key types and how the structure of its query language code interacts with table configuration caching. Also, there is a lot of headroom for better performance.

License

This is licensed under the Affero GPL v3 (unlike RethinkDB, which is Apache 2). Right now, all of the post-Apache 2 modifications are copyrighted one person, so flexibility on this is possbile.

RethinkDB (Original README below)

What is RethinkDB?

  • Open-source database for building realtime web applications
  • NoSQL database that stores schemaless JSON documents
  • Distributed database that is easy to scale
  • High availability database with automatic failover and robust fault tolerance

RethinkDB is the first open-source scalable database built for realtime applications. It exposes a new database access model, in which the developer can tell the database to continuously push updated query results to applications without polling for changes. RethinkDB allows developers to build scalable realtime apps in a fraction of the time with less effort.

To learn more, check out rethinkdb.com.

Not sure what types of projects RethinkDB can help you build? Here are a few examples:

Quickstart

For a thirty-second RethinkDB quickstart, check out rethinkdb.com/docs/quickstart.

Or, get started right away with our ten-minute guide in these languages:

Besides our four official drivers, we also have many third-party drivers supported by the RethinkDB community. Here are a few of them:

Looking to explore what else RethinkDB offers or the specifics of ReQL? Check out our RethinkDB docs and ReQL API.

Building

First install some dependencies. For example, on Ubuntu or Debian:

sudo apt-get install build-essential protobuf-compiler \
    # python \  # for older distros
    python3 python-is-python3 \
    libprotobuf-dev libcurl4-openssl-dev \
    libncurses5-dev libjemalloc-dev wget m4 g++ libssl-dev

Generally, you will need

  • GCC or Clang
  • Protocol Buffers
  • jemalloc
  • Ncurses
  • Python 2 or Python 3
  • libcurl
  • libcrypto (OpenSSL)
  • libssl-dev

Then, to build:

./configure --allow-fetch
# or run ./configure --allow-fetch CXX=clang++

make -j4
# or run make -j4 DEBUG=1

sudo make install
# or run ./build/debug_clang/rethinkdb

See WINDOWS.md and mk/README.md for build instructions for Windows and FreeBSD.

Need help?

A great place to start is rethinkdb.com/community. Here you can find out how to ask us questions, reach out to us, or report an issue. You'll be able to find all the places we frequent online and at which conference or meetups you might be able to meet us next.

If you need help right now, you can also find us on Slack, Twitter, or IRC at #rethinkdb on Freenode.

Donors

  • CNCF
  • Digital Ocean provides infrastructure and servers needed for serving mission-critical sites like download.rethinkdb.com or update.rethinkdb.com
  • Atlassian provides OSS license to be able to handle internal tickets like vulnerability issues
  • Netlify OSS license to be able to migrate rethinkdb.com
  • DNSimple provides DNS services for the RethinkDB project
  • ZeroTier sponsored the development of per-table configurable write aggregation including the ability to set write delay to infinite to create a memory-only table (PR #6392)

Licensing

RethinkDB is licensed by the Linux Foundation under the open-source Apache 2.0 license. Portions of the software are licensed by Google and others and used with permission or subject to their respective license agreements.

Where's the changelog?

We keep a list of changes and feature explanations here.