gormutil

Documentation

Index

• Constants
• func Paginate(db *gorm.DB, req *ListOptions, data any) (count int64, err error)
• func Paginator(req *ListOptions) func(db *gorm.DB) *gorm.DB
• type ListOptions
  • func (req *ListOptions) SetDefaultOptions()

Constants

const (
	// DefaultLimit define the default number of records to be retrieved.
	DefaultLimit = 15

	ASC  = "ASC"
	DESC = "DESC"
)

Functions

func Paginate

func Paginate(db *gorm.DB, req *ListOptions, data any) (count int64, err error)

Paginate the query.

func Paginator

func Paginator(req *ListOptions) func(db *gorm.DB) *gorm.DB

Paginator returns a gorm scope paginator.

Types

type ListOptions

type ListOptions struct {
	// Page
	Page int `form:"page"`

	// Offset
	Offset int `form:"offset"`

	// Limit
	Limit int `form:"limit"`

	// Order asc or desc.
	Order string `form:"order"`

	// Sort field.
	Sort string `form:"sort"`
}

ListOptions contains offset and limit fields.

func (*ListOptions) SetDefaultOptions

func (req *ListOptions) SetDefaultOptions()

SetDefaultOptions Set default options if not exist.