db

README

数据库

底层使用gorm库进行封装，支持多种数据库、支持单库与多库模式。

多库模式基于gorm.io/plugin/dbresolver实现。

配置

# 单库模式, key设置为db
driver: mysql
dsn: root:password@tcp(127.0.0.1:3306)/db?charset=utf8mb4&collation=utf8mb4_unicode_ci&parseTime=True&loc=Local&multiStatements=true
prefix: prefix_

# 多库模式, key设置为dbs
default: # 默认链接, 必须设置
  driver: mysql
  dsn: root:password@tcp(127.0.0.1:3306)/db?charset=utf8mb4&collation=utf8mb4_unicode_ci&parseTime=True&loc=Local&multiStatements=true
  prefix: prefix_
clickhouse: # clickhouse
  driver: clickhouse
  dsn: clickhouse://127.0.0.1:9009/default?read_timeout=10s

使用

db.Default().Model(&User{}).Where("id = ?", 1).First(&user)
db.Ctx(ctx).Model(&User{}).Where("id = ?", 1).First(&user)

// 多库
db.With("clickhouse").Model(&User{}).Where("id = ?", 1).First(&user)
db.CtxWith(ctx, "clickhouse").Model(&User{}).Where("id = ?", 1).First(&user)

驱动

默认支持mysql，其它驱动需要使用db.RegisterDriver进行注册。可以参考clickhouse的实现。

import (
_ "github.com/codfrm/cago/database/db/clickhouse"
)

Documentation

Index

• func ContextWith(ctx context.Context, key string) context.Context
• func ContextWithDB(ctx context.Context, db *gorm.DB) context.Context
• func Ctx(ctx context.Context) *gorm.DB
• func CtxWith(ctx context.Context, key string) *gorm.DB
• func Default() *gorm.DB
• func RecordNotFound(err error) bool
• func RegisterDriver(t Driver, f func(*Config) gorm.Dialector)
• func With(key string) *gorm.DB
• type Config
• type DB
  • func Database() *DB
  • func (d *DB) CloseHandle()
  • func (d *DB) Start(ctx context.Context, config *configs.Config) error
• type Driver
• type GroupConfig
• type Logger
  • func NewLogger(driver Driver, config logger.Config) *Logger
  • func (l *Logger) Error(ctx context.Context, msg string, args ...interface{})
  • func (l *Logger) Info(ctx context.Context, msg string, args ...interface{})
  • func (l *Logger) LogMode(level logger.LogLevel) logger.Interface
  • func (l *Logger) ParamsFilter(ctx context.Context, sql string, params ...interface{}) (string, []interface{})
  • func (l *Logger) Trace(ctx context.Context, begin time.Time, ...)
  • func (l *Logger) Warn(ctx context.Context, msg string, args ...interface{})
• type Option
• type Options

Functions

func ContextWith

func ContextWith(ctx context.Context, key string) context.Context

func ContextWithDB

func ContextWithDB(ctx context.Context, db *gorm.DB) context.Context

func Ctx

func Ctx(ctx context.Context) *gorm.DB

func CtxWith

func CtxWith(ctx context.Context, key string) *gorm.DB

func Default

func Default() *gorm.DB

func RecordNotFound

func RecordNotFound(err error) bool

RecordNotFound 判断是否是记录不存在的错误

func RegisterDriver

func RegisterDriver(t Driver, f func(*Config) gorm.Dialector)

func With

func With(key string) *gorm.DB

Types

type Config

type Config struct {
	Driver Driver `yaml:"driver"`
	Dsn    string `yaml:"dsn"`
	Prefix string `yaml:"prefix"`
}

type DB

type DB struct {
	// contains filtered or unexported fields
}

func Database

func Database() *DB

Database gorm数据库封装

func (*DB) CloseHandle

func (d *DB) CloseHandle()

func (*DB) Start

func (d *DB) Start(ctx context.Context, config *configs.Config) error

type Driver

type Driver string

const (
	MySQL      Driver = "mysql"
	Clickhouse Driver = "clickhouse"
)

type GroupConfig

type GroupConfig map[string]*Config

type Logger

type Logger struct {
	logger.Config
	// contains filtered or unexported fields
}

func NewLogger

func NewLogger(driver Driver, config logger.Config) *Logger

func (*Logger) Error

func (l *Logger) Error(ctx context.Context, msg string, args ...interface{})

func (*Logger) Info

func (l *Logger) Info(ctx context.Context, msg string, args ...interface{})

func (*Logger) LogMode

func (l *Logger) LogMode(level logger.LogLevel) logger.Interface

func (*Logger) ParamsFilter

func (l *Logger) ParamsFilter(ctx context.Context, sql string, params ...interface{}) (string, []interface{})

ParamsFilter Trace print sql message

func (*Logger) Trace

func (l *Logger) Trace(ctx context.Context, begin time.Time, fc func() (sql string, rowsAffected int64), err error)

func (*Logger) Warn

func (l *Logger) Warn(ctx context.Context, msg string, args ...interface{})

type Option

type Option func(*Options)

type Options

type Options struct {
}