xdb

Documentation

Index

• Constants
• Variables
• func Deregister(name string)
• func GetDbType(dbtype string) (reflect.Type, bool)
• func NewBuilder() container.StandardBuilder
• func NewError(err error, execSql string, args []interface{}) error
• func NewPanicError(err error, strace string) error
• func Register(resolver Resover)
• func RegisterDbType(dbType string, reflectType reflect.Type) (err error)
• func RegistryLogger(logger Logger)
• type Config
  • func DefaultRefactor(connName string, cfg *Config) (newcfg *Config, err error)
• type DbError
• type Executer
• type IDB
• type ITrans
• type Logger
  • func GetLogger(loggerName string) (Logger, bool)
• type Option
  • func WithLifeTime(lifeTime int) Option
  • func WithLoggerName(name string) Option
  • func WithLongQueryTime(longQueryTime int) Option
  • func WithMaxIdle(maxIdle int) Option
  • func WithMaxOpen(maxOpen int) Option
  • func WithShowQueryLog(showQueryLog bool) Option
• type PanicError
• type RawMessage
  • func (m RawMessage) MarshalJSON() ([]byte, error)
  • func (m *RawMessage) UnmarshalJSON(data []byte) error
• type Resover
• type Result
• type Row
  • func NewRow() Row
• type Rows
  • func NewRows() Rows
• type StandardDB
  • func NewStandardDB(container container.Container) StandardDB
• type TransactionCallback

Constants

const DbTypeNode = "dbs"

Variables

var (
	SecretKey         = "glue.xdb12345678"
	SecretMode        = "cbc/pkcs7"
	BaseSecretEnvName = "BASE_SECRET_ENV_NAME"
)

var ConnRefactor func(connName string, cfg *Config) (newcfg *Config, err error)

数据库连接重构方法

var (
	DateFormat = "2006-01-02 15:04:05"
)

var DecryptConn func(connName, conn string) (newConn string, err error) = defaultDecryptConn

var Default = &Config{
	MaxOpen:       10,
	MaxIdle:       5,
	LifeTime:      600,
	ShowQueryLog:  false,
	LongQueryTime: 500,
	LoggerName:    "dbslowsql",
	Debug:         false,
}

Functions

func Deregister

func Deregister(name string)

Deregister 清理配置适配器

func GetDbType

func GetDbType(dbtype string) (reflect.Type, bool)

func NewBuilder

func NewBuilder() container.StandardBuilder

func NewError

func NewError(err error, execSql string, args []interface{}) error

func NewPanicError

func NewPanicError(err error, strace string) error

func Register

func Register(resolver Resover)

Register 注册配置文件适配器

func RegisterDbType

func RegisterDbType(dbType string, reflectType reflect.Type) (err error)

func RegistryLogger

func RegistryLogger(logger Logger)

Types

type Config

type Config struct {
	Proto         string `json:"proto" valid:"required"`
	Conn          string `json:"conn" valid:"required" label:"连接字符串"`
	MaxOpen       int    `json:"max_open" valid:"required" label:"最大打开连接数"`
	MaxIdle       int    `json:"max_idle" valid:"required" label:"最大空闲连接数"`
	LifeTime      int    `json:"life_time" valid:"required" label:"单个连接时长(秒)"`
	ShowQueryLog  bool   `json:"show_query_log"  label:"开启慢查询日志"`
	LongQueryTime int    `json:"long_query_time"  label:"慢查询阈值(毫秒)"`
	LoggerName    string `json:"logger_name" label:"日志提供程序"`
	Debug         bool   `json:"debug" label:"调试模式"`
}

func DefaultRefactor

func DefaultRefactor(connName string, cfg *Config) (newcfg *Config, err error)

type DbError

type DbError interface {
	Error() string
	Inner() error
	SQL() string
	Args() []interface{}
}

type Executer

type Executer interface {
	Query(ctx context.Context, sql string, input map[string]interface{}) (data Rows, err error)
	Multi(ctx context.Context, sql string, input map[string]interface{}) (data []Rows, err error)
	First(ctx context.Context, sql string, input map[string]interface{}) (data Row, err error)
	Scalar(ctx context.Context, sql string, input map[string]interface{}) (data interface{}, err error)
	Exec(ctx context.Context, sql string, input map[string]interface{}) (r Result, err error)
}

Executer 数据库操作对象集合

type IDB

type IDB interface {
	Executer
	Begin() (ITrans, error)
	Close() error
	GetImpl() interface{}
	Transaction(TransactionCallback) error
}

IDB 数据库操作接口

type ITrans

type ITrans interface {
	Executer
	Rollback() error
	Commit() error
}

ITrans 数据库事务接口

type Logger

type Logger interface {
	Name() string
	Log(ctx context.Context, elapsed int64, sql string, args ...interface{})
}

func GetLogger

func GetLogger(loggerName string) (Logger, bool)

type Option

type Option func(*Config)

Option 配置选项

func WithLifeTime

func WithLifeTime(lifeTime int) Option

func WithLoggerName

func WithLoggerName(name string) Option

func WithLongQueryTime

func WithLongQueryTime(longQueryTime int) Option

func WithMaxIdle

func WithMaxIdle(maxIdle int) Option

func WithMaxOpen

func WithMaxOpen(maxOpen int) Option

func WithShowQueryLog

func WithShowQueryLog(showQueryLog bool) Option

type PanicError

type PanicError interface {
	Error() string
	StackTrace() string
}

type RawMessage

type RawMessage []byte

func (RawMessage) MarshalJSON

func (m RawMessage) MarshalJSON() ([]byte, error)

MarshalJSON returns m as the JSON encoding of m.

func (*RawMessage) UnmarshalJSON

func (m *RawMessage) UnmarshalJSON(data []byte) error

UnmarshalJSON sets *m to a copy of data.

type Resover

type Resover interface {
	Name() string
	Resolve(connName string, setting config.Config) (interface{}, error)
}

dbResover 定义配置文件转换方法

type Result

type Result = sql.Result

type Row

type Row = xtypes.XMap

Row 单行数据

func NewRow

func NewRow() Row

NewRow 构建Row对象

type Rows

type Rows = xtypes.XMaps

Rows 多行数据

func NewRows

func NewRows() Rows

NewRows 构建Rows

type StandardDB

type StandardDB interface {
	GetDB(name ...string) (q IDB)
	GetImpl(name ...string) interface{}
}

StandardDB

func NewStandardDB

func NewStandardDB(container container.Container) StandardDB

NewStandardDBs 创建DB

type TransactionCallback

type TransactionCallback func(dbObj Executer) error