persistence

README

App starter ORM

Documentation

Index

• Variables
• func CheckErr(err error) error
• func InitDatabase(config BaseConfig) (err error)
• func InitOrm(config BaseConfig) (err error)
• func RegisterDataBase(init bool, aliasName, driverName, dataSource string, params ...orm.DBOption) (err error)
• func RegisterDatabase(config BaseConfig) (err error)
• func RegisterDriver(driver Driver) (err error)
• func RegisterModels(models ...interface{})
• type BaseConfig
  • func (b *BaseConfig) MaxConn(n int)
  • func (b *BaseConfig) MaxIdle(n int)
  • func (b *BaseConfig) RegisterModel(models ...interface{})
• type Driver
• type DriverType
• type MysqlConfig
  • func (c *MysqlConfig) Build() (b BaseConfig)
• type OrmContext
  • func New() *OrmContext
  • func NewOrm(aliasName string) *OrmContext
  • func (o *OrmContext) Transaction(h func(TxContext) error) (err error)
• type Pager
  • func BuildPager(pageNo int, pageSize int) Pager
  • func (p *Pager) GetLimit() (limit int, start int)
  • func (p *Pager) IsFirstPage() bool
  • func (p *Pager) IsLastPage() bool
  • func (p *Pager) Next()
  • func (p *Pager) SetPageNo(no int)
  • func (p *Pager) SetTotal(total int)
• type PostgresConfig
  • func (c *PostgresConfig) Build() (b BaseConfig)
• type SqliteConfig
  • func (c *SqliteConfig) Build() (b BaseConfig)
• type TxContext

Variables

var DriverMysql = Driver{"mysql", orm.DRMySQL}

var DriverOracle = Driver{"oracle", orm.DROracle}

var DriverPostgres = Driver{"postgres", orm.DRPostgres}

var DriverSqlite = Driver{"sqlite3", orm.DRSqlite}

var DriverTiDB = Driver{"tidb", orm.DRTiDB}

Functions

func CheckErr

func CheckErr(err error) error

func InitDatabase

func InitDatabase(config BaseConfig) (err error)

func InitOrm

func InitOrm(config BaseConfig) (err error)

func RegisterDataBase

func RegisterDataBase(init bool, aliasName, driverName, dataSource string, params ...orm.DBOption) (err error)

func RegisterDatabase

func RegisterDatabase(config BaseConfig) (err error)

func RegisterDriver

func RegisterDriver(driver Driver) (err error)

func RegisterModels

func RegisterModels(models ...interface{})

Types

type BaseConfig

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

func (*BaseConfig) MaxConn

func (b *BaseConfig) MaxConn(n int)

func (*BaseConfig) MaxIdle

func (b *BaseConfig) MaxIdle(n int)

func (*BaseConfig) RegisterModel

func (b *BaseConfig) RegisterModel(models ...interface{})

type Driver

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

type DriverType

type DriverType orm.DriverType

DriverType RegisterModel

type MysqlConfig

type MysqlConfig struct {
	InitDb    bool
	AliasName string
	UserName  string
	Password  string
	Host      string
	Port      int
	MaxIdle   int
	MaxConn   int
	DbName    string
}

func (*MysqlConfig) Build

func (c *MysqlConfig) Build() (b BaseConfig)

type OrmContext

type OrmContext struct {
	Context orm.Ormer
}

func New

func New() *OrmContext

func NewOrm

func NewOrm(aliasName string) *OrmContext

func (*OrmContext) Transaction

func (o *OrmContext) Transaction(h func(TxContext) error) (err error)

type Pager

type Pager struct {
	PageNo     int // start with 1
	PageSize   int // > 0
	TotalPage  int
	TotalCount int
}

func BuildPager

func BuildPager(pageNo int, pageSize int) Pager

func (*Pager) GetLimit

func (p *Pager) GetLimit() (limit int, start int)

func (*Pager) IsFirstPage

func (p *Pager) IsFirstPage() bool

func (*Pager) IsLastPage

func (p *Pager) IsLastPage() bool

func (*Pager) Next

func (p *Pager) Next()

func (*Pager) SetPageNo

func (p *Pager) SetPageNo(no int)

func (*Pager) SetTotal

func (p *Pager) SetTotal(total int)

type PostgresConfig

type PostgresConfig struct {
	InitDb    bool
	AliasName string
	UserName  string
	Password  string
	Host      string
	Port      int
	DbName    string
	MaxIdle   int
	MaxConn   int
	SSL       string
}

func (*PostgresConfig) Build

func (c *PostgresConfig) Build() (b BaseConfig)

type SqliteConfig

type SqliteConfig struct {
	Database  string
	AliasName string
	InitDb    bool
}

func (*SqliteConfig) Build

func (c *SqliteConfig) Build() (b BaseConfig)

type TxContext

type TxContext struct {
	Context orm.TxOrmer
}