Merge pull request #15 from ric-v/dev

BoltDB support added

README.md

@@ -22,12 +22,12 @@ Simple DB CRUD operations service. Supports some golang Key-Value pair file base
 
 - [x] ~~Upload existing DB~~
 - [x] ~~View Key-Value pairs~~
-- [x] Add new Key-Value pair
-- [x] Remove Key-Value pair
-- [x] Update Key-Value pair
-- [x] Download updated file
-- [ ] View Buckets in boltDB
-- [ ] Add / remove bucket
+- [x] ~~Add new Key-Value pair~~
+- [x] ~~Remove Key-Value pair~~
+- [x] ~~Update Key-Value pair~~
+- [x] ~~Download updated file~~
+- [x] View Buckets in boltDB
+- [x] Add / remove bucket
 - [ ] Move/Copy Key-Value pair under a bucket to another bucket
 
 ## Usage

VERSION

@@ -1 +1 @@
-v.0.0.3
+v.0.1.1

database/boltdb_tx.go

@@ -6,15 +6,23 @@ import (
 	"github.com/boltdb/bolt"
 )
 
+type buckets interface {
+	AddBucket(string)
+	SetBucket(string)
+	ListBuckets() ([]string, error)
+	DeleteBucket(string) error
+}
+
 // BoltDB - BoltDB struct
 type BoltDB struct {
 	*bolt.DB
 	bucketName []byte
+	buckets
 }
 
-// BoltBucket godoc - BoltDB Bucket struct
-type BoltBucket struct {
-	*bolt.DB
+// Conn godoc - Returns the underlying database connection
+func (db *BoltDB) Conn() interface{} {
+	return db
 }
 
 // openBolt godoc - Creates a new BoltDB instance
@@ -101,3 +109,48 @@ func (db *BoltDB) List(args ...interface{}) (data []KeyValuePair, err error) {
 	})
 	return
 }
+
+// AddBucket godoc - Adds a new bucket to the database
+func (db *BoltDB) AddBucket(bucketName string) error {
+
+	// add the bucket to the boltdb file
+	return db.Update(func(t *bolt.Tx) error {
+		_, err := t.CreateBucketIfNotExists([]byte(bucketName))
+		return err
+	})
+}
+
+// SetBucket godoc - Sets the current bucket
+func (db *BoltDB) SetBucket(bucketName string) {
+	db.bucketName = []byte(bucketName)
+}
+
+// SetBucket godoc - Sets the current bucket
+func (db *BoltDB) GetDefBucket() string {
+	return string(db.bucketName)
+}
+
+// ListBuckets godoc - Lists all buckets in the database
+func (db *BoltDB) ListBuckets() (data []string, err error) {
+
+	// open the db in view mode
+	err = db.View(func(tx *bolt.Tx) error {
+
+		// iterate on each buckets from the db
+		err = tx.ForEach(func(name []byte, _ *bolt.Bucket) error {
+			data = append(data, string(name))
+			return err
+		})
+		return err
+	})
+	return
+}
+
+// DeleteBucket godoc - Deletes a bucket from the database
+func (db *BoltDB) DeleteBucket(bucketName string) error {
+
+	// delete the bucket from the boltdb file
+	return db.Update(func(tx *bolt.Tx) error {
+		return tx.DeleteBucket([]byte(bucketName))
+	})
+}

database/buntdb_tx.go

@@ -9,6 +9,11 @@ type BuntDB struct {
 	*buntdb.DB
 }
 
+// Conn godoc - Returns the underlying database connection
+func (db *BuntDB) Conn() interface{} {
+	return db
+}
+
 // openBunt godoc - Creates a new BuntDB instance
 func openBunt(fileName string) (db *BuntDB, err error) {
 

database/database.go

@@ -16,21 +16,14 @@ type KeyValuePair struct {
 
 // DB interface for underlying database packages
 type DB interface {
+	Conn() interface{}
 	Add(string, string, ...interface{}) error
 	CloseDB()
 	Get(key string) (string, error) // TODO: add list all keys
 	Delete(string) error
 	List(args ...interface{}) ([]KeyValuePair, error)
 }
 
-// Buckets interface for underlying bolt DB buckets
-type Buckets interface {
-	Add()
-	Get()
-	List()
-	Delete()
-}
-
 // DBType for identifying underlying database packages
 type DBType string
 

server/bucket.go

@@ -1,20 +1,157 @@
 package server
 
 import (
+	"encoding/json"
 	"log"
+	"net/url"
 
+	"github.com/ric-v/divulge-keyvalue-db-ui/database"
 	"github.com/valyala/fasthttp"
 )
 
+// addBucket is the handler for the POST /api/v1/db/bucket/dbKey/file endpoint.
+// Adds a new bucket to the open DB file.
+func addBucket(ctx *fasthttp.RequestCtx) {
+
+	var bucket string
+	// get the dbKey from header
+	dbSession, err := handleDBSession(ctx)
+	if err != nil {
+		log.Println(err)
+		ctx.Error(err.Error(), fasthttp.StatusInternalServerError)
+		return
+	}
+
+	switch dbSession.DBType {
+
+	case database.BOLT_DB:
+		// get the DB type from params
+		bucket = string(ctx.QueryArgs().Peek("bucket"))
+		log.Println("bucket:", bucket)
+
+		// add the bucket to the db
+		err := dbSession.DB.Conn().(*database.BoltDB).AddBucket(bucket)
+		if err != nil {
+			log.Println(err)
+			ctx.Error(err.Error(), fasthttp.StatusInternalServerError)
+			return
+		}
+
+	default:
+		log.Println("DB type not supported:", dbSession.DBType)
+		ctx.Error("DB type not supported: "+dbSession.DBType, fasthttp.StatusInternalServerError)
+		return
+	}
+
+	// return success message to UI
+	json.NewEncoder(ctx).Encode(generateResponse("Successfully added bucket: "+bucket, nil, &dbSession))
+}
+
 // listBucket godoc - loads the list of buckets in a boltdb file
 func listBuckets(ctx *fasthttp.RequestCtx) {
 
-	// get the dbKey from params
-	dbKey := string(ctx.QueryArgs().Peek("dbKey"))
-	log.Println("dbKey:", dbKey)
+	type bucketList struct {
+		Buckets       []string `json:"buckets"`
+		DefaultBucket string   `json:"defaultBucket"`
+	}
+
+	var buckets bucketList
+
+	// get the dbKey from header
+	dbSession, err := handleDBSession(ctx)
+	if err != nil {
+		log.Println(err)
+		ctx.Error(err.Error(), fasthttp.StatusInternalServerError)
+		return
+	}
+
+	switch dbSession.DBType {
+
+	case database.BOLT_DB:
+		var err error
+		// get the list of buckets from the db
+		list, err := dbSession.DB.Conn().(*database.BoltDB).ListBuckets()
+		if err != nil {
+			log.Println(err)
+			ctx.Error(err.Error(), fasthttp.StatusInternalServerError)
+			return
+		}
+		buckets.Buckets = list
+		buckets.DefaultBucket = dbSession.DB.Conn().(*database.BoltDB).GetDefBucket()
+	}
+
+	// return success message to UI
+	json.NewEncoder(ctx).Encode(generateResponse("", buckets, &dbSession))
+}
+
+// setBucket is the handler for the POST /api/v1/db/bucket/dbKey/file endpoint.
+func setBucket(ctx *fasthttp.RequestCtx) {
+
+	var bucket string
+	// get the dbKey from header
+	dbSession, err := handleDBSession(ctx)
+	if err != nil {
+		log.Println(err)
+		ctx.Error(err.Error(), fasthttp.StatusInternalServerError)
+		return
+	}
+
+	switch dbSession.DBType {
+
+	case database.BOLT_DB:
+		// get the DB type from params
+		bucket = string(ctx.UserValue("bucket").(string))
+		bucket, _ = url.QueryUnescape(bucket)
+		log.Println("bucket:", bucket)
+
+		// set the bucket in the db
+		dbSession.DB.Conn().(*database.BoltDB).SetBucket(bucket)
+
+	default:
+		log.Println("DB type not supported:", dbSession.DBType)
+		ctx.Error("DB type not supported: "+dbSession.DBType, fasthttp.StatusInternalServerError)
+		return
+	}
 
+	// return success message to UI
+	json.NewEncoder(ctx).Encode(generateResponse("Successfully applied default bucket: "+bucket, nil, &dbSession))
 }
 
-func getBucket(ctx *fasthttp.RequestCtx) {
+// deleteBucket is the handler for the POST /api/v1/db/bucket/dbKey/file endpoint.
+// Removes a bucket from the open DB file.
+func deleteBucket(ctx *fasthttp.RequestCtx) {
+
+	var bucket string
+	// get the dbKey from header
+	dbSession, err := handleDBSession(ctx)
+	if err != nil {
+		log.Println(err)
+		ctx.Error(err.Error(), fasthttp.StatusInternalServerError)
+		return
+	}
+
+	switch dbSession.DBType {
+
+	case database.BOLT_DB:
+
+		// get the DB type from params
+		bucket = string(ctx.QueryArgs().Peek("bucket"))
+		log.Println("bucket:", bucket)
+
+		// delete the bucket from the db
+		err := dbSession.DB.Conn().(*database.BoltDB).DeleteBucket(bucket)
+		if err != nil {
+			log.Println(err)
+			ctx.Error(err.Error(), fasthttp.StatusInternalServerError)
+			return
+		}
+
+	default:
+		log.Println("DB type not supported:", dbSession.DBType)
+		ctx.Error("DB type not supported: "+dbSession.DBType, fasthttp.StatusInternalServerError)
+		return
+	}
 
+	// return success message to UI
+	json.NewEncoder(ctx).Encode(generateResponse("Successfully removed bucket: "+bucket, nil, &dbSession))
 }