rk-boot/database/clickhouse

Table of Contents generated with DocToc

Quick Start
YAML Options
- Usage of locale
Development Status: Stable

Quick Start

In the bellow example, we will run ClickHouse locally and implement API of Create/List/Get/Update/Delete for User model with Gin.

GET /v1/user, List users
GET /v1/user/:id, Get user
PUT /v1/user, Create user
POST /v1/user/:id, Update user
DELETE /v1/user/:id, Delete user

Installation

In this example, we will start a web service with gin. As a result, bellow dependencies should be installed.

go get github.com/rookie-ninja/rk-boot/gin
go get github.com/rookie-ninja/rk-boot/database/clickhouse

Start ClickHouse with docker

We are going to use [default:"""] as credential of ClickHouse.

$ docker run -d --name clickhouse -p 9000:9000 --ulimit nofile=262144:262144 yandex/clickhouse-server

1.Create boot.yaml

Create web server with Gin framework at port 8080
Create ClickHouse entry which connects ClickHouse at localhost:9000

---
gin:
  - name: user-service
    port: 8080
    enabled: true
clickHouse:
  - name: user                             # Required
    enabled: true                          # Required
    locale: "*::*::*::*"                   # Required
    addr: "localhost:9000"                 # Optional, default: localhost:9000
    user: default                          # Optional, default: default
    pass: ""                               # Optional, default: ""
    database:
      - name: usermeta                     # Required
        autoCreate: true                   # Optional, default: false
#        dryRun: false                     # Optional, default: false
#        params: []                        # Optional, default: []
#    logger:
#      level: warn                         # Optional, default: warn
#      encoding: json                      # Optional, default: console
#      outputPaths: [ "clickhouse/log" ]   # Optional, default: []

2.Create main.go

In the main() function, we implement two things.

Add User{} as auto migrate option which will create table in DB automatically if missing.
Register APIs into Gin router.

// Copyright (c) 2021 rookie-ninja
//
// Use of this source code is governed by an Apache-style
// license that can be found in the LICENSE file.
package main

import (
	"context"
	"github.com/gin-gonic/gin"
	"github.com/rookie-ninja/rk-boot"
	"github.com/rookie-ninja/rk-boot/database/clickhouse"
	"github.com/rookie-ninja/rk-boot/gin"
	"github.com/rs/xid"
	"gorm.io/gorm"
	"net/http"
	"time"
)

var userDb *gorm.DB

func main() {
	boot := rkboot.NewBoot()

	boot.Bootstrap(context.TODO())

	// Auto migrate database and init global userDb variable
	userDb = rkbootclickhouse.GetGormDb("user", "usermeta")

	if !userDb.DryRun {
		userDb.AutoMigrate(&User{})
	}

	// Register APIs
	ginEntry := rkbootgin.GetGinEntry("user-service")
	ginEntry.Router.GET("/v1/user", ListUsers)
	ginEntry.Router.GET("/v1/user/:id", GetUser)
	ginEntry.Router.PUT("/v1/user", CreateUser)
	ginEntry.Router.POST("/v1/user/:id", UpdateUser)
	ginEntry.Router.DELETE("/v1/user/:id", DeleteUser)

	boot.WaitForShutdownSig(context.TODO())
}

// *************************************
// *************** Model ***************
// *************************************

type Base struct {
	CreatedAt time.Time `yaml:"-" json:"-"`
	UpdatedAt time.Time `yaml:"-" json:"-"`
}

type User struct {
	Base
	Id   string `yaml:"id" json:"id"`
	Name string `yaml:"name" json:"name"`
}

func ListUsers(ctx *gin.Context) {
	userList := make([]*User, 0)
	res := userDb.Find(&userList)

	if res.Error != nil {
		ctx.JSON(http.StatusInternalServerError, res.Error)
		return
	}
	ctx.JSON(http.StatusOK, userList)
}

func GetUser(ctx *gin.Context) {
	uid := ctx.Param("id")
	user := &User{}
	res := userDb.Find(user, "id = ?", uid)

	if res.Error != nil {
		ctx.JSON(http.StatusInternalServerError, res.Error)
		return
	}
	ctx.JSON(http.StatusOK, user)
}

func CreateUser(ctx *gin.Context) {
	user := &User{
		Id:   xid.New().String(),
		Name: ctx.Query("name"),
	}

	res := userDb.Create(user)

	if res.Error != nil {
		ctx.JSON(http.StatusInternalServerError, res.Error)
		return
	}
	ctx.JSON(http.StatusOK, user)
}

func UpdateUser(ctx *gin.Context) {
	uid := ctx.Param("id")
	user := &User{
		Id:   uid,
		Name: ctx.Query("name"),
	}

	res := userDb.Where("id = ?", uid).Updates(user)

	if res.Error != nil {
		ctx.JSON(http.StatusInternalServerError, res.Error)
		return
	}

	ctx.JSON(http.StatusOK, user)
}

func DeleteUser(ctx *gin.Context) {
	uid := ctx.Param("id")

	res := userDb.Delete(&User{}, "id = ?", uid)

	if res.Error != nil {
		ctx.JSON(http.StatusInternalServerError, res.Error)
		return
	}

	ctx.String(http.StatusOK, "success")
}

3.Start server

$ go run main.go

2022-01-09T05:25:50.341+0800    INFO    boot/gin_entry.go:913   Bootstrap ginEntry      {"eventId": "9eaeab9a-5d95-440c-9a5a-abce6159e884", "entryName": "user-service"}
------------------------------------------------------------------------
endTime=2022-01-09T05:25:50.341891+08:00
startTime=2022-01-09T05:25:50.341803+08:00
elapsedNano=87212
timezone=CST
ids={"eventId":"9eaeab9a-5d95-440c-9a5a-abce6159e884"}
app={"appName":"rk","appVersion":"","entryName":"user-service","entryType":"GinEntry"}
env={"arch":"amd64","az":"*","domain":"*","hostname":"lark.local","localIP":"10.8.0.2","os":"darwin","realm":"*","region":"*"}
payloads={"ginPort":8080}
error={}
counters={}
pairs={}
timing={}
remoteAddr=localhost
operation=Bootstrap
resCode=OK
eventStatus=Ended
EOE
2022-01-09T05:25:50.341+0800    INFO    Bootstrap ClickHouse entry      {"entryName": "user", "clickHouseUser": "default", "clickHouseAddr": "localhost:9000"}
2022-01-09T05:25:50.341+0800    INFO    creating database usermeta if not exists
2022-01-09T05:25:50.361+0800    INFO    creating successs or database usermeta exists
2022-01-09T05:25:50.361+0800    INFO    connecting to database usermeta
2022-01-09T05:25:50.371+0800    INFO    connecting to database usermeta success

4.Validation

4.1 Create user

Create a user with name of rk-dev.

$ curl -X PUT "localhost:8080/v1/user?name=rk-dev"
{"id":"c7d038jd0cvvjkhma6dg","name":"rk-dev"}

4.1 Update user

Update user name to rk-dev-updated.

$ curl -X POST "localhost:8080/v1/user/c7d038jd0cvvjkhma6dg?name=rk-dev-updated"
{"id":"c7d038jd0cvvjkhma6dg","name":"rk-dev-updated"}

4.1 List users

List users.

$ curl -X GET localhost:8080/v1/user
[{"id":"c7d038jd0cvvjkhma6dg","name":"rk-dev-updated"}]

4.1 Get user

Get user with id=c7d038jd0cvvjkhma6dg.

$ curl -X GET localhost:8080/v1/user/c7d038jd0cvvjkhma6dg
{"id":"c7d038jd0cvvjkhma6dg","name":"rk-dev-updated"}

4.1 Delete user

$ curl -X DELETE localhost:8080/v1/user/c7d038jd0cvvjkhma6dg
success

YAML Options

User can start multiple gorm instances at the same time. Please make sure use different names.

name	Required	description	type	default value
clickHouse.name	Required	The name of entry	string	ClickHouse
clickHouse.enabled	Required	Enable entry or not	bool	false
clickHouse.locale	Required	See locale description bellow	string	""
clickHouse.description	Optional	Description of echo entry.	string	""
clickHouse.user	Optional	ClickHouse username	string	root
clickHouse.pass	Optional	ClickHouse password	string	pass
clickHouse.addr	Optional	ClickHouse remote address	string	localhost:9000
clickHouse.database.name	Required	Name of database	string	""
clickHouse.database.autoCreate	Optional	Create DB if missing	bool	false
clickHouse.database.dryRun	Optional	Run gorm.DB with dry run mode	bool	false
clickHouse.database.params	Optional	Connection params	[]string	[""]
clickHouse.logger.encoding	Optional	Log encoding type, json & console are available options	string	console
clickHouse.logger.outputPaths	Optional	Output paths of logger	[]string	[stdout]
clickHouse.logger.level	Optional	Logger level, options: silent, error, warn, info	string	warn

Usage of locale

RK use <realm>::<region>::<az>::<domain> to distinguish different environment.
Variable of <locale> could be composed as form of <realm>::<region>::<az>::<domain>
- realm: It could be a company, department and so on, like RK-Corp.
         Environment variable: REALM
         Eg: RK-Corp
         Wildcard: supported

- region: Please see AWS web site: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html
          Environment variable: REGION
          Eg: us-east
          Wildcard: supported

- az: Availability zone, please see AWS web site for details: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html
      Environment variable: AZ
      Eg: us-east-1
      Wildcard: supported

- domain: Stands for different environment, like dev, test, prod and so on, users can define it by themselves.
          Environment variable: DOMAIN
          Eg: prod
          Wildcard: supported

How it works?
First, we will split locale with "::" and extract realm, region, az and domain.
Second, get environment variable named as REALM, REGION, AZ and DOMAIN.
Finally, compare every element in locale variable and environment variable.
If variables in locale represented as wildcard(*), we will ignore comparison step.

Example:
# let's assuming we are going to define DB address which is different based on environment.
# Then, user can distinguish DB address based on locale.
# We recommend to include locale with wildcard.
---
DB:
  - name: redis-default
    locale: "*::*::*::*"
    addr: "192.0.0.1:6379"
  - name: redis-in-test
    locale: "*::*::*::test"
    addr: "192.0.0.1:6379"
  - name: redis-in-prod
    locale: "*::*::*::prod"
    addr: "176.0.0.1:6379"

Development Status: Stable

Released under the Apache 2.0 License

# README