models

README

#NOTE Models in this directory are jsx models. We copy them here from jumpscale threebot just for easier regeneration. So, they need to be always in sync with the one in jumpscale threebot repo.

Documentation

Index

• Constants
• Variables
• func MustID(ctx context.Context, db *mongo.Database, collection string) schema.ID
• func NextID(ctx context.Context, db *mongo.Database, collection string) (schema.ID, error)
• func NrPages(total, pageSize int64) int64
• func Pages(p Pager, total int64) int64
• func QueryInt(r *http.Request, q string) (int64, error)
• type Pager
  • func Page(p int64, size ...int64) Pager
  • func PageFromRequest(r *http.Request) Pager

Constants

const (
	//Counters is the counters collection in mongo
	Counters = "counters"
)

const (
	// DefaultPageSize is default page size
	DefaultPageSize int64 = 100
)

Variables

var (
	//ErrFailedToGetID is base error for generation failure
	ErrFailedToGetID = errors.New("failed to generate new id")
)

Functions

func MustID

func MustID(ctx context.Context, db *mongo.Database, collection string) schema.ID

MustID must get next available ID, or panic with an error that has error.Is(err, ErrFailedToGetID) == true

func NextID

func NextID(ctx context.Context, db *mongo.Database, collection string) (schema.ID, error)

NextID for a collection

func NrPages

func NrPages(total, pageSize int64) int64

NrPages compute the number of page of a collection

func Pages

func Pages(p Pager, total int64) int64

Pages return number of pages based on the total number

func QueryInt

func QueryInt(r *http.Request, q string) (int64, error)

QueryInt get integer from query string

Types

type Pager

type Pager *options.FindOptions

Pager is the find options wrapper

func Page

func Page(p int64, size ...int64) Pager

Page creates a Pager

func PageFromRequest

func PageFromRequest(r *http.Request) Pager

PageFromRequest return page information from the page & size url params