paginator

README

gorm-paginator

Usage

go get github.com/Leukocyte-Lab/gorm-paginator

pgntr := paginator.New(page, orders, map[string]string{})

var models []*Model
result := pgntr.GenGormTransaction(dao.DB).Find(&models)
if result.Error != nil {
    // TODO: handle error
}

err := pgntr.CountPageTotal(result)
if result.Error != nil {
    // TODO: handle error
}

// return models, pgntr.Page

License

MIT

Documentation

Index

• Constants
• type Direction
  • func (enum Direction) String() string
• type Order
• type Page
  • func GenPage(pageNo int, pageSize int) Page
• type Paginator
  • func New(page Page, orders []Order, filter map[string]string) *Paginator
  • func (pgntr *Paginator) CountPageTotal(tx *gorm.DB) error
  • func (pgntr Paginator) GenGormTransaction(tx *gorm.DB) *gorm.DB
  • func (pgntr *Paginator) LimitPageTotal()
  • func (pgntr Paginator) Paging(tx *gorm.DB, dest interface{}) (*Page, error)

Constants

const (
	MaxPageSize     = 100
	DefaultPageSize = 20
)

const (
	MinPageNumber = 1
	MinPageSize   = 1
)

Types

type Direction

type Direction int

Direction is sort direction when ordering

const (
	SortASC Direction
	SortDESC
)

func (Direction) String

func (enum Direction) String() string

type Order

type Order struct {
	Column    string
	Direction Direction
}

Order contains sort direction and sort field

type Page

type Page struct {
	Number int
	Size   int
	Total  int
}

page contains page number, page size, and total number of items

func GenPage

func GenPage(pageNo int, pageSize int) Page

GenPage is helper function to generate page with default page number and page size

type Paginator

type Paginator struct {
	Page   Page
	Order  []Order
	Filter map[string]string
}

Paginator is basic struct contains pagination information

func New

func New(page Page, orders []Order, filter map[string]string) *Paginator

New is helper function for create Paginator instance

func (*Paginator) CountPageTotal

func (pgntr *Paginator) CountPageTotal(tx *gorm.DB) error

CountPageTotal is setter of Paginator.Page.Total by counting total page number

func (Paginator) GenGormTransaction

func (pgntr Paginator) GenGormTransaction(tx *gorm.DB) *gorm.DB

GenGormTransaction generate GORMv2 sql Transaction (gorm.DB) for paging

func (*Paginator) LimitPageTotal

func (pgntr *Paginator) LimitPageTotal()

func (Paginator) Paging

func (pgntr Paginator) Paging(tx *gorm.DB, dest interface{}) (*Page, error)

Paging is wrapper for doing paging easily