https://github.com/ahopkins/merkava

A fast ordered NoSQL database.
https://github.com/ahopkins/merkava

database nosql

Last synced: about 1 month ago
JSON representation

A fast ordered NoSQL database.

• Host: GitHub
• URL: https://github.com/ahopkins/merkava
• Owner: ahopkins
• License: mit
• Created: 2017-09-23T22:54:00.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2023-02-04T02:39:41.000Z (almost 2 years ago)
• Last Synced: 2024-09-15T07:21:19.034Z (about 2 months ago)
• Topics: database, nosql
• Language: Rust
• Homepage:
• Size: 504 KB
• Stars: 8
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • Changelog: HISTORY.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
=============================

MerkavaDB

=============================

.. note::

    This is still in **active** development. Things will change. If you are interested in helping out, or would like to see any particular features added, let me know.

.. image:: https://raw.githubusercontent.com/ahopkins/merkava/master/assets/logo.png

What is MerkavaDB?

------------------

A fast, and lightweight DB for storing ordered data. The order it comes out is the order that it went in. The API is meant to be small and without bloated queries. Consequently, there is a limited set of queries to be made since the primary tool is getting objects in and out of storage in a specific order.

So, why would I use it?

-----------------------

Because it is fast. And it is simple.

Let's say you want to have a chat or a news feed. The data will ALWAYS be displayed in the same order. Why not persist your data objects in the order you want them in?

MerkavaDB stores whatever data you need it to. It is schemaless. If you can transfer it, it will store.

How do I use it?

----------------

By making TCP connection to the database server. All you need to do is specify a "channel" and some data. The protocol is simple:

::

      \n

    

Note, the line break at the end of the message is critical. As is the single spacing.

Your response will be:

::

    OK 

    

    or

    

    ER 

What is a channel?

++++++++++++++++++

A channel is a division of data. All data is stored in a sequential order for a given channel. For example, it could be a single chat room or news feed.

Supported Operations

--------------------

- ``PUSH`` - add a new item to the channel

- ``RETRIEVE`` - get a single item by id from the channel

- ``RECENT`` - get ``n` items from the channel

- ``UPDATE`` - change a single item

- ``DELETE`` - remove an item from a channel *(not yet implemented)*

- ``RESTORE`` - return a deleted item to the channel *(not yet implemented)*

- ``PURGE`` - cleanup all deleted items *(not yet implemented)*

- ``FLUSH`` - empty a channel

- ``BACKUP`` - persist a channel to disk

- ``STATS`` - receive information and stats about a channel

Examples

--------

| ``foo PUSH this is a message``

| ``foo RECENT``

| ``foo RECENT 5`` 5 most recent messages

| ``foo RECENT 5 2`` 5 most recent messages, offset by 2

| ``foo RETRIEVE EaR1US7HVN6xuSG-2SgJtA``

| ``foo STATS``

| 

Roadmap

-------

There currently is a proof of concept implementation out there. It is being rebuilt from the ground up in Rust. More to come later.