bolt

README

Web Application with Bolt Database

This is the web application with Bolt database.

As you can see below, the usage is extremely simple, hiboot support dependency injection, all you have to do is config data source in application.yml, add tags in struct, then you have database repository injected in your service.

You don't have to learn the bolt database API, hiboot hide all complexities behind the scenes.

Application entry point

main.go

package main

import (
	"hidevops.io/hiboot/pkg/starter/web"
	_ "hidevops.io/hiboot/examples/db/bolt/controllers"
)

func main()  {
	// create new web application and run it
	web.NewApplication().Run()
}

Config data source

dataSources:
- type: bolt # database type
  database: hi.db # database file path, e.g. /var/lib/data/hi.db or relative path hi.db
  mode: 0600 # database file permission
  timeout: 1 # connection timeout in second

Inject Service into Controller

In order to inject Repository into Service, you need to

• add tag component:"service" to field UserService of UserController

type UserController struct {
	web.Controller

	UserService *services.UserService `component:"service"`
}

Inject Repository into Service

In order to inject Repository into Service, you need to

• import hidevops.io/hiboot/pkg/starter/db
• add tag component:"repository" dataSourceType:"bolt" to the field Repository of UserService

import (
	"hidevops.io/hiboot/pkg/starter/db"
)

type UserService struct {
	Repository db.KVRepository `component:"repository" dataSourceType:"bolt"`
}

How to use

KVRepository interface

// KVRepository is the Key/Value Repository interface
type KVRepository interface {
	// Put key value pair to specific bucket
	Put(bucket, key, value []byte) error
	// Get value from specific bucket with key
	Get(bucket, key []byte) ([]byte, error)
	// Delete key in specific bucket
	Delete(bucket, key []byte) error
}

Use the KVRepository interface

func (us *UserService) AddUser(user *domain.User) error {
	u, err := json.Marshal(user)
	if err == nil {
		// This is how we call Put function of Repository interface
		us.Repository.Put([]byte("user"), []byte(user.Id), u)
	}
	return err
}


func (us *UserService) GetUser(id string) (*domain.User, error) {
	
	// Get the User from Repository
	u, err := us.Repository.Get([]byte("user"), []byte(id))
	
	if err != nil {
		return nil, err
	}
	var user domain.User
	err = json.Unmarshal(u, &user)
	return &user, err
}

func (us *UserService) DeleteUser(id string) error {
	// Delete the User from Repository
	return us.Repository.Delete([]byte("user"), []byte(id))
}

Run unit test

go test ./...

Run the example code

go run main.go

Run test

Post API

Post User in JSON

curl -H -X POST -d '{"id": "1", "name": "John Doe", "age": 25}' http://localhost:8080/user

The output will be

{
    "code": 200, 
    "data": {
        "Age": 25, 
        "Id": "1", 
        "Name": "John Doe"
    }, 
    "message": "Success"
}

Get API

Get User with Id

curl http://localhost:8080/user?id=1

the output will be

{
    "code": 200, 
    "data": {
        "Age": 25, 
        "Id": "1", 
        "Name": "John Doe"
    }, 
    "message": "Success"
}

Delete API

Delete User

curl -X DELETE http://localhost:8080/user?id=1  

The output will be

{
    "code": 200, 
    "data": null, 
    "message": "Success"
}