mongopagination

Golang Mongo Pagination For Package mongo-go-driver

Simple and easy to use Pagination with information like Total, Page, PerPage, Prev, Next and TotalPage.

Install

$ go get -u -v github.com/gobeam/mongo-go-pagination

or with dep

$ dep ensure -add github.com/gobeam/mongo-go-pagination

Demo

package main

import (
	"context"
	. "github.com/gobeam/mongo-go-pagination"
	"go.mongodb.org/mongo-driver/bson"
	"go.mongodb.org/mongo-driver/mongo"
	"go.mongodb.org/mongo-driver/mongo/options"
	"time"
)

type ToDo struct {
	TaskName string `json:"task_name"`
	TaskStatus string `json:"task_status"`
}

func main() {
	// Establishing mongo db connection
	ctx, _ := context.WithTimeout(context.Background(), 10*time.Second)
	client, err := mongo.Connect(ctx, options.Client().ApplyURI("mongodb://localhost:27017"))
	if err != nil {
		panic(err)
	}

	// making example filter
	filter := bson.M{}
	filter["status"] = 1
	
	var limit int64 = 10
	var page int64 = 1
	
	// Querying paginated data
	paging := PagingQuery{
		Collection: client.Database("db_name").Collection("collection_name"),
		Filter:     filter,
		Limit:      limit,
		Page:       page,
		SortField:  "createdAt",
		SortValue:  -1,
	}
	paginatedData, err := paging.Find()

	// paginated data is in paginatedData.Data
	// pagination info can be accessed in  paginatedData.Pagination
	// if you want to marshal data to your defined struct

	var lists []ToDo
	for _, raw := range paginatedData.Data {
		var todo ToDo
		if err := bson.Unmarshal(raw, &todo); err == nil {
			lists = append(lists, todo)
		}
	}
}
    

Running the tests

$ go test

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

MIT License

Copyright (c) 2020