model

Documentation

Index

• Constants
• func Connection(conn string) (_db *gorm.DB)
• func DB() *gorm.DB
• func Initialize()
• func NewMysql(connection string) *mysql
• func Prefix() string
• func Transaction(tf transactionFunc, attempts uint)
• type BaseModel
  • func (bm *BaseModel) DB() *gorm.DB
  • func (bm *BaseModel) SetDB(db *gorm.DB)
  • func (bm *BaseModel) SetTX(db *gorm.DB)
• type BaseModeller
• type Filter
• type Helper
  • func (h *Helper) Count(in Modeller, filterArr []Filter, withTrashed bool) (count uint, err error)
  • func (h *Helper) Create(out interface{}) error
  • func (h *Helper) Delete(in interface{}, force bool) error
  • func (h *Helper) Exist(in Modeller, withTrashed bool) (exist bool)
  • func (h *Helper) First(out interface{}, withTrashed bool) error
  • func (h *Helper) Q(filterArr []Filter, sortArr []Sort, limit int, withTrashed bool) *gorm.DB
  • func (h *Helper) Restore(in interface{}) error
  • func (h *Helper) Save(out interface{}, modify interface{}) error
  • func (h *Helper) SaveByID(id interface{}, out interface{}, modify interface{}) error
• type Model
  • func (bm *Model) Paginate(model interface{}, c *gin.Context, perPage uint) (pagination Pagination, err error)
• type Modeller
• type OrmConfigurator
• type Pagination
  • func (p *Pagination) Count() uint
  • func (p *Pagination) CurrentPage() uint
  • func (p *Pagination) FirstItem() interface{}
  • func (p *Pagination) ItemArr() interface{}
  • func (p *Pagination) LastItem() interface{}
  • func (p *Pagination) LastPage() uint
  • func (p *Pagination) PerPage() uint
  • func (p *Pagination) Total() uint
• type Sort

Constants

const (
	ASC sortDirection = iota
	DESC
)

Functions

func Connection

func Connection(conn string) (_db *gorm.DB)

func DB

func DB() *gorm.DB

func Initialize

func Initialize()

func NewMysql

func NewMysql(connection string) *mysql

func Prefix

func Prefix() string

func Transaction

func Transaction(tf transactionFunc, attempts uint)

Types

type BaseModel

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

func (*BaseModel) DB

func (bm *BaseModel) DB() *gorm.DB

func (*BaseModel) SetDB

func (bm *BaseModel) SetDB(db *gorm.DB)

func (*BaseModel) SetTX

func (bm *BaseModel) SetTX(db *gorm.DB)

type BaseModeller

type BaseModeller interface {
	DB() *gorm.DB
	SetTX(db *gorm.DB)
}

type Filter

type Filter struct {
	Key string
	Op  string
	Val interface{}
}

type Helper

type Helper struct {
	BaseModel
}

var H Helper

func (*Helper) Count

func (h *Helper) Count(in Modeller, filterArr []Filter, withTrashed bool) (count uint, err error)

func (*Helper) Create

func (h *Helper) Create(out interface{}) error

out must be a struct pointer

func (*Helper) Delete

func (h *Helper) Delete(in interface{}, force bool) error

func (*Helper) Exist

func (h *Helper) Exist(in Modeller, withTrashed bool) (exist bool)

func (*Helper) First

func (h *Helper) First(out interface{}, withTrashed bool) error

out must be a struct pointer

func (*Helper) Q

func (h *Helper) Q(filterArr []Filter, sortArr []Sort, limit int, withTrashed bool) *gorm.DB

func (*Helper) Restore

func (h *Helper) Restore(in interface{}) error

func (*Helper) Save

func (h *Helper) Save(out interface{}, modify interface{}) error

out must be a struct pointer

func (*Helper) SaveByID

func (h *Helper) SaveByID(id interface{}, out interface{}, modify interface{}) error

type Model

type Model gorm.DB

func (*Model) Paginate

func (bm *Model) Paginate(model interface{}, c *gin.Context, perPage uint) (pagination Pagination, err error)

Model(*Q(&User{}, data, []Sort{}, 1, false)).Paginate(c, perPage)

type Modeller

type Modeller interface {
	BaseModeller
	Default() interface{}
	ObjArr(filterArr []Filter, sortArr []Sort, limit int, withTrashed bool) (interface{}, error)
	ObjArrPaginate(c *gin.Context, perPage uint, filterArr []Filter, sortArr []Sort, limit int, withTrashed bool) (pagination Pagination, err error)
}

type OrmConfigurator

type OrmConfigurator interface {
	ConnectionArgs() string
	Driver() string
	Prefix() string
}

type Pagination

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

func (*Pagination) Count

func (p *Pagination) Count() uint

func (*Pagination) CurrentPage

func (p *Pagination) CurrentPage() uint

func (*Pagination) FirstItem

func (p *Pagination) FirstItem() interface{}

func (*Pagination) ItemArr

func (p *Pagination) ItemArr() interface{}

func (*Pagination) LastItem

func (p *Pagination) LastItem() interface{}

func (*Pagination) LastPage

func (p *Pagination) LastPage() uint

func (*Pagination) PerPage

func (p *Pagination) PerPage() uint

func (*Pagination) Total

func (p *Pagination) Total() uint

type Sort

type Sort struct {
	Key       string
	Direction sortDirection
}