{"id":13878807,"url":"https://github.com/roma/roma","last_synced_at":"2025-07-16T14:33:00.173Z","repository":{"id":56892594,"uuid":"345739","full_name":"roma/roma","owner":"roma","description":"ROMA: A Distributed Key-Value Store in Ruby","archived":false,"fork":false,"pushed_at":"2019-06-21T10:24:42.000Z","size":1854,"stargazers_count":327,"open_issues_count":21,"forks_count":40,"subscribers_count":25,"default_branch":"dev2_0","last_synced_at":"2024-11-10T10:49:49.085Z","etag":null,"topics":["kvs","memcached","rakuten","roma","ruby"],"latest_commit_sha":null,"homepage":"http://roma-kvs.org/","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/roma.png","metadata":{"files":{"readme":"README.md","changelog":"ChangeLog.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2009-10-22T06:58:50.000Z","updated_at":"2024-07-09T09:43:06.000Z","dependencies_parsed_at":"2022-08-21T01:20:48.913Z","dependency_job_id":null,"html_url":"https://github.com/roma/roma","commit_stats":null,"previous_names":[],"tags_count":23,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roma%2Froma","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roma%2Froma/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roma%2Froma/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roma%2Froma/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/roma","download_url":"https://codeload.github.com/roma/roma/tar.gz/refs/heads/dev2_0","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":226138849,"owners_count":17579496,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["kvs","memcached","rakuten","roma","ruby"],"created_at":"2024-08-06T08:02:00.669Z","updated_at":"2024-11-24T07:31:19.221Z","avatar_url":"https://github.com/roma.png","language":"Ruby","readme":"# ROMA - A Distributed Key-Value Store in Ruby \n[![Gitter](https://badges.gitter.im/roma/roma.svg)](https://gitter.im/roma/roma?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge)\n[![Build Status](https://travis-ci.org/roma/roma.svg?branch=master)](https://travis-ci.org/roma/roma)\n[![Test Coverage](https://codeclimate.com/github/roma/roma/badges/coverage.svg)](https://codeclimate.com/github/roma/roma/coverage)\n[![Code Climate](https://codeclimate.com/github/roma/roma/badges/gpa.svg)](https://codeclimate.com/github/roma/roma)\n[![Issue Count](https://codeclimate.com/github/roma/roma/badges/issue_count.svg)](https://codeclimate.com/github/roma/roma)\n\nROMA is one of the data storing systems for distributed key-value stores.  \nIt is a completely decentralized distributed system that consists of multiple\nprocesses, called nodes, on several machines. It is based on pure P2P architecture  \nlike a distributed hash table, thus it provides high availability and scalability.\n\nROMA is written in Ruby. However, following choices are available to\naccess to ROMA.\n\n* Client libraries of Ruby and Java are available.\n* ROMA protocol is compatible with memcached text-based one so that  \n  any memcached client libraries allows users to interact with ROMA.\n\nMore information is [here](http://roma-kvs.org/ \"ROMA\").\n\n## Documentation\n\n* Refer to [ROMA documentations](http://roma-kvs.org/ \"ROMA\")\n\n## Requirements\n* Ruby \u003e= 2.1.0\n\n\n\n## Installation\n### Install ROMA\nYou can simply install ROMA and dependency libralies by using a `gem` command of Ruby as follows.\n\n```\n$ gem install roma\n```\n\n### Make routing files\n\nROMA is required to make the routing files before starting up.  \nThe routing file is stored the routing information of each processes.\n\n```\n$ mkroute localhost_10001 localhost_10002 --replication_in_host\n```\n\nIf succeeded, two new files which named localhost_10001.route and localhost_10002.route created in the current directory.  \nRefer to [Commands](http://roma-kvs.org/commands.html \"Commands\") for more detail information about Shell Commands.  \n\n### Start up ROMA\nRun two processes by using a romad.rb program as follows:  \n\n```\n$ romad localhost -p 10001 -d --replication_in_host\n$ romad localhost -p 10002 -d --replication_in_host\n```\n\nRefer to [Shell Commands](http://roma-kvs.org/commands.html#dist-jump-link-shell_commands) for more detail information about Shell Commands.  \n\n## Usage\nLike memcached, you can connect to ROMA with telnet. Connect to the ROMA process that you ran above.\n\n```\n$ telnet localhost 10001\n```\n\nYou can interact with ROMA in the same way of memcached commands.\n\n```\nset foo 0 0 3 \u003creturn\u003e\nbar \u003creturn\u003e\nSTORED\nget foo \u003creturn\u003e\nVALUE foo 0 3\nbar\nEND\n```\n\nRefer to [Commands](http://roma-kvs.org/commands.html \"Commands\") for more detail information about ROMA Commands.\n\n\n## Contributing\n\nIf you would like to contribute, please...\n\n1. Fork and git clone it.\n2. Install gems required for development.\n3. Make changes in a branch \u0026 add unit tests.\n4. Run Unit Test\n  * `bundle exec rake` (if unit test fails, run it again - it's fickle).\n  * Specify `STORAGE` to test test cases related to storages such as groonga, sqlite3 and dbm.\n5. Create a pull request.\n\nContributions, improvements, comments and suggestions are welcome!\n\n## Promoters\nRoma is promoted by [Rakuten, Inc.](http://global.rakuten.com/corp/) and [Rakuten Institute of Technology](http://rit.rakuten.co.jp/).\n","funding_links":[],"categories":["Ruby"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Froma%2Froma","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Froma%2Froma","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Froma%2Froma/lists"}