q

Documentation

Index

• type AndList
  • func NewAndList(values []interface{}) *AndList
• type FuzzyMatchValue
  • func NewFuzzyMatchValue(value string) *FuzzyMatchValue
• type KeyWords
• type OrList
  • func NewOrList(values []interface{}) *OrList
• type Query
  • func MustClone(query *Query) *Query
  • func New(kw KeyWords) *Query
  • func (q *Query) First(sorting ...*Sort) *Query
  • func (q *Query) Limit() int
  • func (q *Query) Offset() int
  • func (q *Query) WithPagination(c *gin.Context) *Query
• type Range
  • func NewRange(min, max interface{}) *Range
• type Sort
  • func NewSort(key string, desc bool) *Sort

Types

type AndList

type AndList struct {
	Values []interface{}
}

AndList query

func NewAndList

func NewAndList(values []interface{}) *AndList

NewAndList creates a new and list

type FuzzyMatchValue

type FuzzyMatchValue struct {
	Value string
}

FuzzyMatchValue query

func NewFuzzyMatchValue

func NewFuzzyMatchValue(value string) *FuzzyMatchValue

NewFuzzyMatchValue creates a new fuzzy match

type KeyWords

type KeyWords = map[string]interface{}

KeyWords ...

type OrList

type OrList struct {
	Values []interface{}
}

OrList query

func NewOrList

func NewOrList(values []interface{}) *OrList

NewOrList creates a new or list

type Query

type Query struct {
	// Filter list
	Keywords KeyWords
	// Sort list
	Sorts []*Sort
	// Page number
	PageNumber int
	// Page size
	PageSize int
	// Without pagination
	WithoutPagination bool
}

Query parameters

func MustClone

func MustClone(query *Query) *Query

MustClone returns the clone of query when it's not nil or returns a new Query instance

func New

func New(kw KeyWords) *Query

New returns Query with keywords

func (*Query) First

func (q *Query) First(sorting ...*Sort) *Query

First make the query only fetch the first one record in the sorting order

func (*Query) Limit

func (q *Query) Limit() int

func (*Query) Offset

func (q *Query) Offset() int

func (*Query) WithPagination

func (q *Query) WithPagination(c *gin.Context) *Query

type Range

type Range struct {
	Min interface{}
	Max interface{}
}

Range query

func NewRange

func NewRange(min, max interface{}) *Range

NewRange creates a new range

type Sort

type Sort struct {
	Key  string
	DESC bool
}

Sort specifies the order information

func NewSort

func NewSort(key string, desc bool) *Sort

NewSort creates new sort