kevaf

README

kevaf

Lightweight file-base KVS for golang.

Install

go get github.com/inabajunmr/kevaf

Usage

package main

import (
	"fmt"
	"os"

	kevaf "github.com/inabajunmr/kevaf"
)

func main() {

	// prepare dir for kevaf
	os.Mkdir("./.kvs", 0777)
	kvs := kevaf.FileMap{"./.kvs"}

	// put new value
	err := kvs.Put("key", []byte("value"))
	if err != nil {
		fmt.Println("Failed to put.", err)
		os.Exit(1)
	}

	// get put value
	val, err := kvs.Get("key")
	if err != nil {
		fmt.Println("key is empty")
		os.Exit(1)
	}

	fmt.Println(string(val)) // value
}

Documentation

Overview

Package kevaf is light-weight filebase kvs.

Index

• type Map
  • func NewMap(path string) (*Map, error)
  • func (f Map) Get(key string) (value []byte, err error)
  • func (f Map) Put(key string, value []byte) error
  • func (f Map) Remove(key string) (err error)
  • func (f Map) RemoveAll() (err error)

Types

type Map

type Map struct {
	Path string
}

Map is file base Kvs interface

func NewMap

func NewMap(path string) (*Map, error)

NewMap is Constructor

func (Map) Get

func (f Map) Get(key string) (value []byte, err error)

Get read file matching key underneath FileMap.Path

func (Map) Put

func (f Map) Put(key string, value []byte) error

Put create file by filename as key and content as value When failed to write file, return error

func (Map) Remove

func (f Map) Remove(key string) (err error)

Remove specific data by matching key

func (Map) RemoveAll

func (f Map) RemoveAll() (err error)

RemoveAll data