cyandb

README

CyanDB

About

This is a simple key-value database written in go. CyanDB is persistent, and is not an in-memory database.

Project Status

This project is in early stages of development and should not be used in production

To install:

For all platforms: Make sure that your GOBIN directory, typically ~/go/bin/ is in your PATH

• Windows:

go get github.com/SatvikR/cyandb/cmd/cyand
go get github.com/SatvikR/cyandb/cmd/cyansh

• Linux/Mac:

go get github.com/SatvikR/cyandb/cmd/cyand
go get github.com/SatvikR/cyandb/cmd/cyansh

sudo cp $(which cyand) /usr/bin

To compile from source:

From the root of the repository, run the following:

• Windows: .\make.bat install

• Linux: make install

To compile for development:

From the root of the repository, run the following:

• Windows: .\make.bat

• Linux: make

Binaries will show up in ./bin folder

To clean binaries:

• Windows: .\make.bat clean
• Linux: make clean

LICENSE

Apache 2.0

FAQ

• Where does the name CyanDB come from?
  • I was originally going to call this project BlueDB, but apparently that already existed. When I asked one of my friends, Alexandre2006, "What should I rename BlueDB to?", he replied "CyanDB."

Documentation

Overview

CyanDB is a simple key value database

Server:

Once installed, use the `cyand` command to run.

Client:

Once installed, use the `cyansh` command to run

Syntax: Cyandb uses a JSON syntax. As of now, there are two commands, set and get.

Set: args: key, value ex.

{
	"command": "set",
	"args": ["hello", "world"]
}

Get: args: key ex.

{
	"command": "get",
	"args": ["hello"]
}