B

barrel-platform

Distributed database for the modern world

Name Last Update
.github Loading commit data...
.gitlab/issue_templates Loading commit data...
apps Loading commit data...
config Loading commit data...
support Loading commit data...
.codeclimate.yml Loading commit data...
.gitignore Loading commit data...
.gitlab-ci.yml Loading commit data...
LICENSE Loading commit data...
Makefile Loading commit data...
README.md Loading commit data...
rebar.config Loading commit data...
rebar.lock Loading commit data...

build status

A document-oriented database targeting data locality & P2P - barrel-db.org

Barrel platform

Barrel is a modern document-oriented database in Erlang focusing on data locality (put/match the data next to you) and P2P.

Barrel must also be able to work in unreliable conditions were sometimes the quorum can't be achieved (because it is working offline or in other conditions).

Because Barrel is built on an existing relatively small code base, it is possible to make radical changes as part of an incremental process. Underpinning, all this work is efficient for small and large data systems — something rare among database systems.

Requirements

  • OS supported: Linux, OSX, BSDs
  • Erlang 19.2

Prerequisites

This repository contains an Erlang project packaged with rebar3. You need to have Erlang 19.1 and the latest version of rebar3 installed to be able to create a release.

Quickstart

$ make rel
$ ./_build/default/rel/barrel/bin/barrel start

Building a release

Execute the following command line:

$ make rel

The generated release can be found in the folder _build/prod/rel .

to build a development release, run the command line make devrel . Please note that this release can't be shipped outside of the current project, the release will be found in the folder _build/default/rel.

Testing a release

To start a barrel http server:

$ ./_build/prod/rel/barrel/bin/barrel start

To stop it:

$ ./_build/prod/rel/barrel/bin/barrel stop

List of available commands:

$ ./_build/prod/rel/barrel/bin/barrel

You can consult the embedded Swagger page at http://localhost:7080/api-docs

Packaging an autonomous tar file

This command create a tarbal including barrek, erlang and associated libs:

$ make tar

You can deploy the tarball wherever you want:

$ mkdir barrelprod
$ cd barrelprod
$ tar -xzf ../barrel-0.1.0.tar.gz
$ bin/barrel_http start