gormx

Documentation

Index

• Constants
• func CreateSSHConn(cnf *SSHConfig) (*ssh.Client, error)
• func Dsn2DB(dsnURL string, withLog bool) (*gorm.DB, error)
• func ForUpdate(db *gorm.DB, lock bool) *gorm.DB
• func IsDupError(err error) bool
• func IsNotFoundErr(err error) bool
• func New(dsn string, opts ...Option) (*gorm.DB, error)
• func NewDBByDsn(dsn *Dsn, opts ...Option) (*gorm.DB, error)
• func NewDBBySSH(sshCnf *SSHConfig, dsn *Dsn, opts ...Option) (*gorm.DB, error)
• func NewGorm(dsn string, maxOpenConn, maxIdle int, maxLifeTime time.Duration, log bool) (*gorm.DB, error)
• func NewUberLogger() logger.Interface
• func ToGRPCDupErr(err error) error
• func ToGRPCNotFoundErr(err error) error
• func Transact(db *gorm.DB, fnList ...GormProcFn) (err error)
• type Dsn
  • func (d *Dsn) String() string
  • func (d *Dsn) UseDefault() string
• type GormProcFn
  • func Combine(fns ...GormProcFn) GormProcFn
• type Option
  • func WithLog() Option
  • func WithLogSwitch(on bool) Option
  • func WithLogger(logger logger.Interface) Option
  • func WithMaxIdle(maxIdle int) Option
  • func WithMaxLifeTime(maxLifeTime time.Duration) Option
  • func WithMaxOpenConn(maxOpenConn int) Option
• type SSHConfig
• type SSHDialer
  • func (d *SSHDialer) Dial(ctx context.Context, addr string) (net.Conn, error)
  • func (d *SSHDialer) Register()

Constants

const (
	DefaultMaxOpenCount = 40
	DefaultMaxIdleCount = 20
	DefaultMaxLifeTime  = time.Hour
)

Functions

func CreateSSHConn

func CreateSSHConn(cnf *SSHConfig) (*ssh.Client, error)

func Dsn2DB

func Dsn2DB(dsnURL string, withLog bool) (*gorm.DB, error)

Dsn2DB from dsn json string to db

func ForUpdate

func ForUpdate(db *gorm.DB, lock bool) *gorm.DB

ForUpdate : add "for update" for "select" or not

func IsDupError

func IsDupError(err error) bool

IsDupError is duplicated key error

func IsNotFoundErr

func IsNotFoundErr(err error) bool

IsNotFoundErr is not found error

func New

func New(dsn string, opts ...Option) (*gorm.DB, error)

New : new *gorm.DB

func NewDBByDsn

func NewDBByDsn(dsn *Dsn, opts ...Option) (*gorm.DB, error)

NewDBByDsn : new *gorm.DB by Dsn

func NewDBBySSH

func NewDBBySSH(sshCnf *SSHConfig, dsn *Dsn, opts ...Option) (*gorm.DB, error)

NewDBBySSH new db by ssh

func NewGorm

func NewGorm(dsn string, maxOpenConn, maxIdle int, maxLifeTime time.Duration, log bool) (*gorm.DB, error)

NewGorm 获取一个db客户端 --maxOpenConn 最大打开连接数

func NewUberLogger

func NewUberLogger() logger.Interface

NewUberLogger 创建一个新的 GORM 日志适配器

func ToGRPCDupErr

func ToGRPCDupErr(err error) error

ToGRPCDupErr err to grpc duplicate

func ToGRPCNotFoundErr

func ToGRPCNotFoundErr(err error) error

ToGRPCNotFoundErr error to grpc

func Transact

func Transact(db *gorm.DB, fnList ...GormProcFn) (err error)

Transact : db transaction nolint : nakedret // using named return for defer func

Types

type Dsn

type Dsn struct {
	User     string            `json:"user" toml:"user"`
	Password string            `json:"password" toml:"password"`
	Proto    string            `json:"proto" toml:"proto"`
	Host     string            `json:"host" toml:"host"`
	Schema   string            `json:"schema" toml:"schema"`
	Options  map[string]string `json:"options" toml:"options"`
}

func (*Dsn) String

func (d *Dsn) String() string

func (*Dsn) UseDefault

func (d *Dsn) UseDefault() string

type GormProcFn

type GormProcFn func(txn *gorm.DB) error

GormProcFn gorm func

func Combine

func Combine(fns ...GormProcFn) GormProcFn

Combine : combine serial GormProcFn to one to avoid append

type Option

type Option func(*_Option)

func WithLog

func WithLog() Option

func WithLogSwitch

func WithLogSwitch(on bool) Option

func WithLogger

func WithLogger(logger logger.Interface) Option

WithLogger : set logger

func WithMaxIdle

func WithMaxIdle(maxIdle int) Option

func WithMaxLifeTime

func WithMaxLifeTime(maxLifeTime time.Duration) Option

func WithMaxOpenConn

func WithMaxOpenConn(maxOpenConn int) Option

type SSHConfig

type SSHConfig struct {
	Host string `json:"host" toml:"host"`
	User string `json:"user" toml:"user"`
	Pk   string `json:"pk" toml:"pk"`
	Port int    `json:"port" toml:"port"`
}

type SSHDialer

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

func (*SSHDialer) Dial

func (d *SSHDialer) Dial(ctx context.Context, addr string) (net.Conn, error)

func (*SSHDialer) Register

func (d *SSHDialer) Register()