sinri/kola-db

Simple Information Storage Service

0.1.1 2018-06-19 04:01 UTC

Requires

• sinri/ark: ~1.6

GPL-3.0-or-later

• Sinri Edogawa

README

Simple Information Storage Service.

https://sinri.github.io/KolaDB/index.html

composer require sinri/kola-db

Structure

A simple three level object storage structure and simple key-value properties within objects.

Cluster::DIR {
    Collection::DIR {
        Object::JSON_FILE {
            field1:value1,
            field2:value2
        }
    }
}

Action

Action grammar is used to communicate with the server to do certain action.

Action for Drop

{
  "action":"drop",
  "cluster":"CLUSTER_NAME",
  "collection":"COLLECTION_NAME",
  "object":"OBJECT_NAME"
}

Fields collection and object are optional.

Action for Edit

{
  "action":"edit",
  "cluster":"CLUSTER_NAME",
  "collection":"COLLECTION_NAME",
  "object":"OBJECT_NAME",
  "data":{
    "KEY":"VALUE"
  }
}

Action for Rename

{
  "action":"rename",
  "cluster":"CLUSTER_NAME",
  "collection":"COLLECTION_NAME",
  "object":"OBJECT_NAME",
  "change":"NEW_NAME"
}

Fields collection and object are optional.

Action for Query

{
  "action":"query",
  "cluster":"CLUSTER_NAME",
  "collection":"COLLECTION_NAME",
  "query":[
    {
      "method":"EQUAL",
      "field":"FIELD_NAME",
      "reference":"REFERENCE"
    },
    {
      "method":"AND",
      "queries":[
        {
          "method":"EQUAL",
          "field":"FIELD_NAME",
          "reference":"REFERENCE"
        },
        {
          "method":"EQUAL",
          "field":"FIELD_NAME",
          "reference":"REFERENCE"
        }
      ]
    }
  ]
}

Action for List

{
  "action":"list",
  "cluster":"CLUSTER_NAME",
  "collection":"COLLECTION_NAME"
}

Field collection is optional.