Juicy

README

Juicy 🍸

"It was all a dream, I used to read Word Up! magazine."

-- The Notorious B.I.G.

Juicy is a simple memory key/value database. it use naive_raft to support distributed consistency. It is not finished yet, only partial functions are supported.

INSTALL

go get -u github.com/salamer/Juicy

QUICK START

Client Side

package main

import (
	"fmt"

	client "github.com/salamer/Juicy/client"
)

func main() {
	c := client.NewJuicyClient("localhost", 8080)
	c.Set("helloq", "world")
	c.Set("hahah", "wwww")
	c.Set("aaaa", "zzzz")
	fmt.Println(c.Get("aaaa"))
	fmt.Println(c.Get("helloq"))
	fmt.Println(c.Get("hahah"))
	fmt.Println(c.Delete("hahah"))
	fmt.Println(c.Get("hahah"))
	c.Persist("aaa.txt")
	fmt.Println(c.Empty())
	c.Persist("db.juicy")
	c.Clear()
	fmt.Println(c.Empty())
}

Server Side

Single Node

package main

import (
	"fmt"

	Juicy "github.com/salamer/Juicy"
)

func main() {
	db := Juicy.NewDB("hello", Juicy.SINGLE, Juicy.RaftConf{})
	db.Start()
}

Multi Node

package main

import (
	"fmt"

	Juicy "github.com/salamer/Juicy"
)

const ConfPath = {confpath}      //your node conf json file
const ID = {id}                  //your node id
const Name = {name}              //your node name
const Host = {host}              //your raft node host
const Port = {port}              //your raft node port

func main() {
	db := Juicy.NewDB("hello", Juicy.DISTRIBUTED, Juicy.RaftConf{
		ID:       ID,
		Name:     Name,
		ConfPath: ConfPath,
		Port:     Port,
		Host:     Host,
	})
	db.Start()
}

TODO

• Compress
• Better Persist

LICENSE

Copyright © 2018 by Aljun

Under Apache license : http://www.apache.org/licenses/

Documentation

Index

• Constants
• Variables
• func Hash(s string) int
• type DB
  • func GetDBFromFile(filename string) *DB
  • func NewDB(name string, mode int, conf RaftConf, host string, port int) *DB
  • func (db *DB) Clear()
  • func (db *DB) CommandRPC(ctx context.Context, in *pb.CommandReq) (*pb.CommandResp, error)
  • func (db *DB) Delete(key string) error
  • func (db *DB) Empty() bool
  • func (db *DB) GetNode(key string) (*Node, error)
  • func (db *DB) GetValue(key string) (string, error)
  • func (db *DB) HaveKey(key string) (bool, error)
  • func (db *DB) Persist(filename string)
  • func (db *DB) SetValue(key string, value string) error
  • func (db *DB) Size() int
  • func (db *DB) Start()
• type Node
  • func NewNode(key string, value string) *Node
  • func SafeString(a interface{}) (*Node, error)
• type RaftConf

Constants

const (
	SINGLE = iota
	DISTRIBUTED
)

const Newline = "\n"

const SEPARATOR = " "

const SEPARATOR_PLACEHOLER = "\t"

Variables

var (
	KeyError         = errors.New("key not in database")
	ValueError       = errors.New("Value Error")
	MissCommandError = errors.New("Missing right command")
)

Functions

func Hash

func Hash(s string) int

Types

type DB

type DB struct {
	Tree *rbt.Tree

	Mode int
	// contains filtered or unexported fields
}

func GetDBFromFile

func GetDBFromFile(filename string) *DB

func NewDB

func NewDB(name string, mode int, conf RaftConf, host string, port int) *DB

func (*DB) Clear

func (db *DB) Clear()

func (*DB) CommandRPC

func (db *DB) CommandRPC(ctx context.Context, in *pb.CommandReq) (*pb.CommandResp, error)

func (*DB) Delete

func (db *DB) Delete(key string) error

func (*DB) Empty

func (db *DB) Empty() bool

func (*DB) GetNode

func (db *DB) GetNode(key string) (*Node, error)

func (*DB) GetValue

func (db *DB) GetValue(key string) (string, error)

func (*DB) HaveKey

func (db *DB) HaveKey(key string) (bool, error)

func (*DB) Persist

func (db *DB) Persist(filename string)

func (*DB) SetValue

func (db *DB) SetValue(key string, value string) error

func (*DB) Size

func (db *DB) Size() int

func (*DB) Start

func (db *DB) Start()

type Node

type Node struct {
	// contains filtered or unexported fields
}

func NewNode

func NewNode(key string, value string) *Node

func SafeString

func SafeString(a interface{}) (*Node, error)

type RaftConf

type RaftConf struct {
	ID       int
	Name     string
	ConfPath string
	Port     int
	Host     string
}