https://github.com/barrel-db/barrel-platform

Distributed database for the modern world
https://github.com/barrel-db/barrel-platform

barrel barrel-platform database document-database documentdb erlang http json p2p reactive scalability

Last synced: 5 days ago
JSON representation

Distributed database for the modern world

• Host: GitHub
• URL: https://github.com/barrel-db/barrel-platform
• Owner: barrel-db
• License: apache-2.0
• Created: 2015-06-29T13:01:13.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2018-04-06T10:33:23.000Z (over 6 years ago)
• Last Synced: 2024-08-01T12:35:07.405Z (3 months ago)
• Topics: barrel, barrel-platform, database, document-database, documentdb, erlang, http, json, p2p, reactive, scalability
• Language: JavaScript
• Homepage: https://barrel-db.org
• Size: 15.5 MB
• Stars: 207
• Watchers: 23
• Forks: 16
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - barrel-db/barrel-platform - Distributed database for the modern world (p2p)

README

        





   

        

    

   

        

    

   

        

   

   

        

   



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](https://www.erlang.org/) project packaged

with [rebar3](https://www.rebar3.org/). You need to have Erlang 19.1  and the latest version of

[rebar3](http://rebar3.org) 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](http://swagger.io/) 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