sqlx

README

zero-sqlx

zero-sqlx supports leader-follower read-write separation.

installation

go get github.com/chenquan/zero-sqlx

features

• Full tracing
• Read and write separation
• Allows specified leader db execution
• Adaptive circuit breaker
• P2c algorithm

how to use it

DB:
  Leader: leader
  Followers:
    - follower1
    - follower2

type Config struct{
  DB DBConf
}

var c config.Config
conf.MustLoad(*configFile, &c, conf.UseEnv())


mysql := NewMultipleSqlConn("mysql", c.DB)
var name string
mysql.QueryRow(&name, "SELECT name FROM user WHERE id = 1")

Documentation

Index

• Variables
• func ForceLeaderContext(ctx context.Context) context.Context
• func NewMultipleSqlConn(driverName string, conf DBConf, opts ...SqlOption) sqlx.SqlConn
• type DBConf
• type FollowerDB
  • func (f FollowerDB) String() string
• type SqlOption
  • func WithAccept(accept func(err error) bool) SqlOption
  • func WithWatchFollowerDB(watcher <-chan FollowerDB) SqlOption

Variables

var ErrNoFollowerAvailable = errors.New("no follower available")

Functions

func ForceLeaderContext

func ForceLeaderContext(ctx context.Context) context.Context

func NewMultipleSqlConn

func NewMultipleSqlConn(driverName string, conf DBConf, opts ...SqlOption) sqlx.SqlConn

NewMultipleSqlConn returns a SqlConn that supports leader-follower read/write separation.

Types

type DBConf

type DBConf struct {
	Leader       string
	Followers    []string `json:",optional"`
	BackToOrigin bool     `json:",optional"`
}

type FollowerDB

type FollowerDB struct {
	Name       string
	Datasource string
	Added      bool
}

func (FollowerDB) String

func (f FollowerDB) String() string

type SqlOption

type SqlOption func(*sqlOptions)

func WithAccept

func WithAccept(accept func(err error) bool) SqlOption

func WithWatchFollowerDB

func WithWatchFollowerDB(watcher <-chan FollowerDB) SqlOption