database

Documentation

Index

• Constants
• Variables
• func DropSchema(dsn string) error
• func Migrate(dsn string) error
• func New(dsn string) (*gorm.DB, error)
• func Paginate(value interface{}, p Paginable, db *gorm.DB) func(db *gorm.DB) *gorm.DB
• func RegisterModels(objs ...interface{})
• type Paginable
• type Pagination
  • func (p *Pagination) GetLimit() int
  • func (p *Pagination) GetOffset() int
  • func (p *Pagination) GetSort() interface{}
  • func (p *Pagination) SetTotalRows(rows int64)

Constants

const (
	MinPageSize = 10
	MaxPageSize = 50
)

Variables

var (
	ErrBadSortAttribute = errors.New("bad sorting attribute")
)

Functions

func DropSchema

func DropSchema(dsn string) error

func Migrate

func Migrate(dsn string) error

func New

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

func Paginate

func Paginate(value interface{}, p Paginable, db *gorm.DB) func(db *gorm.DB) *gorm.DB

func RegisterModels

func RegisterModels(objs ...interface{})

Types

type Paginable

type Paginable interface {
	SetTotalRows(int64)
	GetOffset() int
	GetLimit() int
	GetSort() interface{}
}

type Pagination

type Pagination struct {
	Limit     int         `json:"limit,omitempty" form:"limit"`
	Offset    int         `json:"offset,omitempty" form:"offset"`
	Sort      string      `json:"sort,omitempty" form:"sort"`
	SortDesc  bool        `json:"sort_desc" form:"sort_desc"`
	TotalRows int64       `json:"total_rows"`
	Rows      interface{} `json:"rows"`
}

func (*Pagination) GetLimit

func (p *Pagination) GetLimit() int

func (*Pagination) GetOffset

func (p *Pagination) GetOffset() int

func (*Pagination) GetSort

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

func (*Pagination) SetTotalRows

func (p *Pagination) SetTotalRows(rows int64)