Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ioquatix/relaxo

Relaxo is a transactional document database built on top of git.
https://github.com/ioquatix/relaxo

database document-storage git relaxo ruby transactional

Last synced: 6 days ago
JSON representation

Relaxo is a transactional document database built on top of git.

Awesome Lists containing this project

README 

        
# ![Relaxo](logo.svg)



Relaxo is a transactional database built on top of git. It's aim is to provide a robust interface for document storage and sorted indexes. If you prefer a higher level interface, you can try [relaxo-model](https://github.com/ioquatix/relaxo-model).



[![Development Status](https://github.com/ioquatix/relaxo/workflows/Test/badge.svg)](https://github.com/ioquatix/relaxo/actions?workflow=Test)



## Installation



Add this line to your application's Gemfile:



``` ruby

gem 'relaxo'

```



And then execute:



    $ bundle



Or install it yourself as:



    $ gem install relaxo



## Usage



Connect to a local database and manipulate some documents.



``` ruby

require 'relaxo'

require 'msgpack'



DB = Relaxo.connect("test")



DB.commit(message: "Create test data") do |dataset|

	object = dataset.append(MessagePack.dump({bob: 'dole'}))

	dataset.write("doc1.msgpack", object)

end



DB.commit(message: "Update test data") do |dataset|

	doc = MessagePack.load dataset.read('doc1.msgpack').data

	doc[:foo] = 'bar'



	object = dataset.append(MessagePack.dump(doc))

	dataset.write("doc2.msgpack", object)

end



doc = MessagePack.load DB.current['doc2.msgpack'].data

puts doc

# => {"bob"=>"dole", "foo"=>"bar"}

```



### Document Storage



Relaxo uses the git persistent data structure for storing documents. This data structure exposes a file-system like interface, which stores any kind of data. This means that you are free to use JSON, or BSON, or MessagePack, or JPEG, or XML, or any combination of those.



Relaxo has a transactional model for both reading and writing.



#### Authors



By default, Relaxo sets up the repository author using the login name and hostname of the current session. You can explicitly change this by modifying `database.config`. Additionally, you can set this per-commit:



``` ruby

database.commit(message: "Testing Enumeration", author: {user: "Alice", email: "alice@localhost"}) do |dataset|

	object = dataset.append("Hello World!")

	dataset.write("hello.txt", object)

end

```



#### Reading Files



``` ruby

path = "path/to/document"



DB.current do |dataset|

	object = dataset.read(path)



	puts "The object id: #{object.oid}"

	puts "The object data size: #{object.size}"

	puts "The object data: #{object.data.inspect}"

end

```



#### Writing Files



``` ruby

path = "path/to/document"

data = MessagePack.dump(document)



DB.commit(message: "Adding document") do |changeset|

	object = changeset.append(data)

	changeset.write(path, object)

end

```



### Datasets and Transactions



`Dataset`s and `Changeset`s are important concepts. Relaxo doesn't allow arbitrary access to data, but instead exposes the git persistent model for both reading and writing. The implications of this are that when reading or writing, you always see a consistent snapshot of the data store.



### Suitability



Relaxo is designed to scale to the hundreds of thousands of documents. It's designed around the git persistent data store, and therefore has some performance and concurrency limitations due to the underlying implementation.



Because it maintains a full history of all changes, the repository would continue to grow over time by default, but there are mechanisms to deal with that.



#### Performance



Relaxo can do anywhere from 1000-10,000 inserts per second depending on how you structure the workload.



    Relaxo Performance

    Warming up --------------------------------------

                  single   129.000  i/100ms

    Calculating -------------------------------------

                  single      6.224k (±14.7%) i/s -    114.036k in  20.000025s

      single transaction should be fast

    Warming up --------------------------------------

                multiple   152.000  i/100ms

    Calculating -------------------------------------

                multiple      1.452k (±15.2%) i/s -     28.120k in  20.101831s

      multiple transactions should be fast



Reading data is lighting fast as it's loaded directly from disk and cached.



### Loading Data



As Relaxo is unapologetically based on git, you can use git directly with a non-bare working directory to add any files you like. You can even point Relaxo at an existing git repository.



### Durability



Relaxo is based on `libgit2` and asserts that it is a transactional database. We base this assertion on:



  - All writes into the object store using `libgit2` are atomic and synchronized to disk.

  - All updates to refs are atomic and synchronized to disk.



Provided these two invariants are maintained, the operation of Relaxo will be safe, even if there are unexpected interruptions to the program.



The durability guarantees of Relaxo depend on [`libgit2` calling `fsync`](https://github.com/libgit2/libgit2/pull/4030), and [this being respected by the underlying hardware](http://www.evanjones.ca/intel-ssd-durability.html). Otherwise, durability cannot be guaranteed.



## Contributing



We welcome contributions to this project.



1.  Fork it.

2.  Create your feature branch (`git checkout -b my-new-feature`).

3.  Commit your changes (`git commit -am 'Add some feature'`).

4.  Push to the branch (`git push origin my-new-feature`).

5.  Create new Pull Request.



### Developer Certificate of Origin



This project uses the [Developer Certificate of Origin](https://developercertificate.org/). All contributors to this project must agree to this document to have their contributions accepted.



### Contributor Covenant



This project is governed by the [Contributor Covenant](https://www.contributor-covenant.org/). All contributors and participants agree to abide by its terms.