pageable

Gorm-Pageable

A page query management of GORM

->中文文档

Installation

We Recommend to use package manager vgo to manage this package

import pageable "github.com/BillSJC/gorm-pageable"

Usage

Just prepare a struct and FOLLOW the code below

package main

import (
    "fmt"
    pageable "github.com/BillSJC/gorm-pageable"
    "github.com/jinzhu/gorm"
)

var DB *gorm.DB //your gorm DB connection

// the struct you want to search
type User struct{
    gorm.Model
    Active bool
    UserName string
    Age uint
}

// a function to get ddata
func getResultSet (page int,rowsPerPage int)(*pageable.Response,error){
    //your empty result set
    resultSet := make([]*User,0,30)
    //prepare a handler to query
    handler := DB.
        Module(&User{}).
        Where(&User{Active:true})
    //use PageQuery to get data
    resp,err := pageable.PageQuery(page,rowsPerPage,handler,&resultSet)
    // handle error
    if err != nil {
        panic(err)
    }
    //Here are the response
	fmt.Println(resp.PageNow)    //PageNow: current page of query
	fmt.Println(resp.PageCount)  //PageCount: total page of the query
	fmt.Println(resp.RawCount)   //RawCount: total raw of query
	fmt.Println(resp.RawPerPage) //RawPerPage: rpp
	fmt.Println(resp.ResultSet)  //ResultSet: result data
	fmt.Println(resp.FirstPage)  //FirstPage: if the result is the first page
	fmt.Println(resp.LastPage)   //LastPage: if the result is the last page
	fmt.Println(resp.Empty)  //Empty: if the result is empty
}

Guidance

Use 0 as the first page

the default first page is 1. However,if u want to use 0 as the first page, just follow this step:

    pageable.Use0AsFirstPage()

Set Default Result Per Page(rpp)

Sometimes you just want to use same rpp in every query, then u just need do this:

    pageable.SetDefaultRPP(25) //set 25 rows per page in every query

And next time, you can use rpp=0 to use Default rpp

    pageable.PageQuery(page:1, rpp:0, queryHandler: ..., resultPtr: ...)

Use custom recovery

The default recovery will only print stack trace. If you want to use your custom Recovery handler, just follow the step:

package main
import (
    "fmt"
    pageable "github.com/BillSJC/gorm-pageable"
)

//your recovery
func myRecovery(){
    if err := recover ; err != nil {
        fmt.Println("something happend")
        fmt.Println(err)
        //then you can do some logs...
    } 
}

func init(){
    //setup your recovery
    pageable.SetRecovery(myRecovery)
}