query

Documentation

Overview

Package query is a library of custom condition queries, support for complex conditional paging queries.

Index

• Constants
• func SetMaxSize(max int)
• type Column
• type Conditions
  • func (c *Conditions) CheckValid() error
  • func (c *Conditions) ConvertToMongo() (bson.M, error)
• type Page
  • func DefaultPage(page int) *Page
  • func NewPage(page int, limit int, columnNames string) *Page
  • func (p *Page) Limit() int
  • func (p *Page) Page() int
  • func (p *Page) Size() int
  • func (p *Page) Skip() int
  • func (p *Page) Sort() bson.D
• type Params
  • func (p *Params) ConvertToMongoFilter() (bson.M, error)
  • func (p *Params) ConvertToPage() (sort bson.D, limit int, skip int)

Constants

const (
	// Eq equal
	Eq = "eq"

	// Neq not equal
	Neq = "neq"

	// Gt greater than
	Gt = "gt"

	// Gte greater than or equal
	Gte = "gte"

	// Lt less than
	Lt = "lt"

	// Lte less than or equal
	Lte = "lte"

	// Like fuzzy lookup
	Like = "like"
	// In include
	In = "in"

	// AND logic and
	AND string = "and" //nolint

	// OR logic or
	OR string = "or" //nolint

)

Functions

func SetMaxSize

func SetMaxSize(max int)

SetMaxSize change the default maximum number of pages per page

Types

type Column

type Column struct {
	Name  string      `json:"name" form:"name"`   // column name
	Exp   string      `json:"exp" form:"exp"`     // expressions, which default to = when the value is null, have =, !=, >, >=, <, <=, like, in
	Value interface{} `json:"value" form:"value"` // column value
	Logic string      `json:"logic" form:"logic"` // logical type, defaults to and when the value is null, with &(and), ||(or)
}

Column query info

type Conditions

type Conditions struct {
	Columns []Column `json:"columns" form:"columns" binding:"min=1"` // columns info
}

Conditions query conditions

func (*Conditions) CheckValid

func (c *Conditions) CheckValid() error

CheckValid check valid

func (*Conditions) ConvertToMongo

func (c *Conditions) ConvertToMongo() (bson.M, error)

ConvertToMongo conversion to mongo-compliant parameters based on the Columns parameter ignore the logical type of the last column, whether it is a one-column or multi-column query

type Page

type Page struct {
	// contains filtered or unexported fields
}

Page info

func DefaultPage

func DefaultPage(page int) *Page

DefaultPage default page, number 20 per page, sorted by id backwards

func NewPage

func NewPage(page int, limit int, columnNames string) *Page

NewPage custom page, starting from page 0. the parameter columnNames indicates a sort field, if empty means id descending, if there are multiple column names, separated by a comma, a '-' sign in front of each column name indicates descending order, otherwise ascending order.

func (*Page) Limit

func (p *Page) Limit() int

Limit number per page

func (*Page) Page

func (p *Page) Page() int

Page get page value

func (*Page) Size

func (p *Page) Size() int

Size number per page Deprecated: use Limit instead, will delete it in the future

func (*Page) Skip

func (p *Page) Skip() int

Skip get offset value

func (*Page) Sort

func (p *Page) Sort() bson.D

Sort get sort field

type Params

type Params struct {
	Page  int    `json:"page" form:"page" binding:"gte=0"`
	Limit int    `json:"limit" form:"limit" binding:"gte=1"`
	Sort  string `json:"sort,omitempty" form:"sort" binding:""`

	Columns []Column `json:"columns,omitempty" form:"columns"` // not required

	// Deprecated: use Limit instead in sunshine version v1.8.6, will remove in the future
	Size int `json:"size" form:"size"`
}

Params query parameters

func (*Params) ConvertToMongoFilter

func (p *Params) ConvertToMongoFilter() (bson.M, error)

ConvertToMongoFilter conversion to mongo-compliant parameters based on the Columns parameter ignore the logical type of the last column, whether it is a one-column or multi-column query

func (*Params) ConvertToPage

func (p *Params) ConvertToPage() (sort bson.D, limit int, skip int)

ConvertToPage converted to page