paginate

README

GORM Paginate

Query Params

type DefaultPagination struct {
	Page   int               `query:"page" minimum:"1" default:"1"`
	Size   int               `query:"size" minimum:"1" default:"10"`
	Sort   string            `query:"sort" description:"1. asc: **id**\n2. desc: **-id**\n3. multi: **id,created_at**"`
	Search string            `query:"search"`
	Filter map[string]string `query:"filter" description:"1. Comparison Operators: **eq**, **ne**, **like**, **contain**, **gt**, **gte**, **lt**, **lte**, **in**\n2. Usage: \"field**[:op]**\":value"`
}

Filter

1. Comparison Operators: eq, ne, like, contain, gt, gte, lt, lte, in
2. Usage: "field[:op]":value

Sort

1. asc: id
2. desc: -id
3. multi: id,created_at

Example

exmaples

Documentation

Index

• func OrderByScope(model any, sort string) func(db *gorm.DB) *gorm.DB
• func Paginate[T any](db *gorm.DB, p Pagination, out *[]T, query ...func(db *gorm.DB) *gorm.DB) (int64, error)
• type DefaultPagination
  • func (p *DefaultPagination) GetFilter() map[string]string
  • func (p *DefaultPagination) GetPage() int
  • func (p *DefaultPagination) GetSearch() string
  • func (p *DefaultPagination) GetSize() int
  • func (p *DefaultPagination) GetSort() string
  • func (p *DefaultPagination) SetDefaultSort(sort string) Pagination
• type Pagination

Functions

func OrderByScope

func OrderByScope(model any, sort string) func(db *gorm.DB) *gorm.DB

func Paginate

func Paginate[T any](db *gorm.DB, p Pagination, out *[]T, query ...func(db *gorm.DB) *gorm.DB) (int64, error)

Types

type DefaultPagination

type DefaultPagination struct {
	Page   int               `query:"page" minimum:"1" default:"1"`
	Size   int               `query:"size" minimum:"1" default:"10"`
	Sort   string            `query:"sort" description:"1. asc: **id**\n2. desc: **-id**\n3. multi: **id,created_at**"`
	Search string            `query:"search"`
	Filter map[string]string `` /* 169-byte string literal not displayed */
}

func (*DefaultPagination) GetFilter

func (p *DefaultPagination) GetFilter() map[string]string

func (*DefaultPagination) GetPage

func (p *DefaultPagination) GetPage() int

func (*DefaultPagination) GetSearch

func (p *DefaultPagination) GetSearch() string

func (*DefaultPagination) GetSize

func (p *DefaultPagination) GetSize() int

func (*DefaultPagination) GetSort

func (p *DefaultPagination) GetSort() string

func (*DefaultPagination) SetDefaultSort

func (p *DefaultPagination) SetDefaultSort(sort string) Pagination

type Pagination

type Pagination interface {
	GetPage() int
	GetSize() int
	GetSort() string
	GetSearch() string
	GetFilter() map[string]string
}