pagination

Documentation

Index

• Constants
• func BindFilteredQuery(c *gin.Context, query *FilteredQuery) error
• func BindQuery(c *gin.Context, query *Query) error
• func CreateAggregationPipeline(query Query, filter []bson.M, sort bson.M, project ...[]bson.M) []bson.M
• type FilteredQuery
• type Query
  • func GetDefaultQuery() Query

Constants

const (
	DefaultPage     = 1
	DefaultLimit    = 10
	DefaultPaginate = true
)

Functions

func BindFilteredQuery

func BindFilteredQuery(c *gin.Context, query *FilteredQuery) error

func BindQuery

func BindQuery(c *gin.Context, query *Query) error

func CreateAggregationPipeline

func CreateAggregationPipeline(
	query Query,
	filter []bson.M,
	sort bson.M,
	project ...[]bson.M,
) []bson.M

Types

type FilteredQuery

type FilteredQuery struct {
	Query
	Search    string `form:"search"`
	Filter    string `form:"filter"`
	Sort      string `form:"sort"`
	WithFlags bool   `form:"with_flags"`
}

type Query

type Query struct {
	Page     int64 `form:"page" binding:"numeric,gt=0"`
	Limit    int64 `form:"limit" binding:"numeric,gt=0"`
	Paginate bool  `form:"paginate"`
}

Query is base request for pagination.

func GetDefaultQuery

func GetDefaultQuery() Query