A revision-oriented DBMS
Java Python C++
Permalink
Failed to load latest commit information.
client
gradle/wrapper
python-client
server
.gitignore
.travis.yml
LICENSE.txt
README.md
build.gradle
gradle.properties
gradlew
gradlew.bat
settings.gradle

README.md

Revori - a revision-oriented DBMS

Build Status

Revori is a database management system designed to handle rapidly-changing data efficiently. In addition to traditional relational database queries, Revori supports query subscriptions which allow clients to retrieve the intial result of a query followed by a stream containing live updates to that result.

The design is a hybrid of a relational database management system and a version control system. A database is represented as an immutable revision from which new revisions may be derived with data added, subtracted, or replaced. These revisions may be compared with each other and/or combined using a three-way merge algorithm.

For more information, see the Wiki

Status

The code is currently in an alpha state, meaning some stuff works, some stuff doesn't, and the API is not yet thoroughly documented and may change without warning. If you're brave and want to start playing with it anyway, you can build and browse the JavaDoc (run ./gradlew javadoc) and consult the test/unittests directory for simple examples of how to use it.

Build

Client

You'll need to have the libreadline headers and library installed to build the client

$ ./gradlew client:build

Server

$ ./gradlew server:build

All

If you want to build it all, just execute:

$ ./gradlew build

Runtime

Server

The following starts/stops the Revori server, which listens to localhost:8017

$ ./gradlew server:[start,stop]

Client

You can use the SQL front-end client to test out Revori:

$ ./client/build/binaries/client localhost 8017

Known Issues

There is a known issue with the native client build on Mac OS X platforms. The version of readline provided by Apple is not 100% compatible with our client implementation. To build and use the client, install the GNU version of readline and readline headers. The easiest way to do this is probably with Homebrew:

$ brew install readline
$ brew link readline # This overrides the Apple-provided version, so beware.