Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/roma/roma
ROMA: A Distributed Key-Value Store in Ruby
https://github.com/roma/roma
kvs memcached rakuten roma ruby
Last synced: 2 months ago
JSON representation
ROMA: A Distributed Key-Value Store in Ruby
- Host: GitHub
- URL: https://github.com/roma/roma
- Owner: roma
- License: gpl-3.0
- Created: 2009-10-22T06:58:50.000Z (over 15 years ago)
- Default Branch: dev2_0
- Last Pushed: 2019-06-21T10:24:42.000Z (over 5 years ago)
- Last Synced: 2024-11-10T10:49:49.085Z (3 months ago)
- Topics: kvs, memcached, rakuten, roma, ruby
- Language: Ruby
- Homepage: http://roma-kvs.org/
- Size: 1.77 MB
- Stars: 327
- Watchers: 25
- Forks: 40
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- Changelog: ChangeLog.md
- License: LICENSE
Awesome Lists containing this project
README
# ROMA - A Distributed Key-Value Store in Ruby
[](https://gitter.im/roma/roma?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
[](https://travis-ci.org/roma/roma)
[](https://codeclimate.com/github/roma/roma/coverage)
[](https://codeclimate.com/github/roma/roma)
[](https://codeclimate.com/github/roma/roma)
ROMA is one of the data storing systems for distributed key-value stores.
It is a completely decentralized distributed system that consists of multiple
processes, called nodes, on several machines. It is based on pure P2P architecture
like a distributed hash table, thus it provides high availability and scalability.
ROMA is written in Ruby. However, following choices are available to
access to ROMA.
* Client libraries of Ruby and Java are available.
* ROMA protocol is compatible with memcached text-based one so that
any memcached client libraries allows users to interact with ROMA.
More information is [here](http://roma-kvs.org/ "ROMA").
## Documentation
* Refer to [ROMA documentations](http://roma-kvs.org/ "ROMA")
## Requirements
* Ruby >= 2.1.0
## Installation
### Install ROMA
You can simply install ROMA and dependency libralies by using a `gem` command of Ruby as follows.
```
$ gem install roma
```
### Make routing files
ROMA is required to make the routing files before starting up.
The routing file is stored the routing information of each processes.
```
$ mkroute localhost_10001 localhost_10002 --replication_in_host
```
If succeeded, two new files which named localhost_10001.route and localhost_10002.route created in the current directory.
Refer to [Commands](http://roma-kvs.org/commands.html "Commands") for more detail information about Shell Commands.
### Start up ROMA
Run two processes by using a romad.rb program as follows:
```
$ romad localhost -p 10001 -d --replication_in_host
$ romad localhost -p 10002 -d --replication_in_host
```
Refer to [Shell Commands](http://roma-kvs.org/commands.html#dist-jump-link-shell_commands) for more detail information about Shell Commands.
## Usage
Like memcached, you can connect to ROMA with telnet. Connect to the ROMA process that you ran above.
```
$ telnet localhost 10001
```
You can interact with ROMA in the same way of memcached commands.
```
set foo 0 0 3
bar
STORED
get foo
VALUE foo 0 3
bar
END
```
Refer to [Commands](http://roma-kvs.org/commands.html "Commands") for more detail information about ROMA Commands.
## Contributing
If you would like to contribute, please...
1. Fork and git clone it.
2. Install gems required for development.
3. Make changes in a branch & add unit tests.
4. Run Unit Test
* `bundle exec rake` (if unit test fails, run it again - it's fickle).
* Specify `STORAGE` to test test cases related to storages such as groonga, sqlite3 and dbm.
5. Create a pull request.
Contributions, improvements, comments and suggestions are welcome!
## Promoters
Roma is promoted by [Rakuten, Inc.](http://global.rakuten.com/corp/) and [Rakuten Institute of Technology](http://rit.rakuten.co.jp/).