query

package

v1.3.1 Latest Latest Go to latest Published: Apr 10, 2023 License: MIT Imports: 7 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/pinosell/gopher

Links

Open Source Insights

Documentation ¶

Index ¶

type Encode
- func (s Encode) Parse() (Query, error)
- func (s Encode) String() string
type FilterClause
- func (c FilterClause) String() string
type FilterFunction
type Query
type SortClause
- func (c SortClause) String() string
type SortFunction

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Encode ¶

type Encode string

const (
	Empty Encode = ""
)

func (Encode) Parse ¶

func (s Encode) Parse() (Query, error)

func (Encode) String ¶

func (s Encode) String() string

type FilterClause ¶

type FilterClause struct {
	Field    string
	Function FilterFunction
	Values   []any
}

func (FilterClause) String ¶

func (c FilterClause) String() string

type FilterFunction ¶

type FilterFunction string

const (
	Null               FilterFunction = "null"
	NotNull            FilterFunction = "nnull"
	Equal              FilterFunction = "eq"
	NotEqual           FilterFunction = "neq"
	GreaterThan        FilterFunction = "gt"
	GreaterThanOrEqual FilterFunction = "gte"
	LessThan           FilterFunction = "lt"
	LessThanOrEqual    FilterFunction = "lte"
	In                 FilterFunction = "in"
	NotIn              FilterFunction = "nin"
	Contains           FilterFunction = "cnt"
	NotContains        FilterFunction = "ncnt"
	Like               FilterFunction = "like"
	NotLike            FilterFunction = "nlike"
)

type Query ¶

type Query map[string][]string

func Count ¶

func Count(flag bool) Query

func Filter ¶

func Filter(field string, function FilterFunction, values ...any) Query

func Include ¶

func Include(includes ...string) Query

func Parse ¶

func Parse(str string) (Query, error)

func Search ¶

func Search(query string) Query

func Skip ¶

func Skip(count int) Query

func Sort ¶

func Sort(field string, function SortFunction) Query

func Take ¶

func Take(count int) Query

func (Query) Count ¶

func (q Query) Count(flag bool) Query

func (Query) CountOnly ¶

func (q Query) CountOnly() bool

func (Query) Encode ¶

func (q Query) Encode() Encode

func (Query) Filter ¶

func (q Query) Filter(field string, function FilterFunction, values ...any) Query

func (Query) FilterClauses ¶

func (q Query) FilterClauses() []*FilterClause

func (Query) Include ¶

func (q Query) Include(includes ...string) Query

func (Query) IncludeItems ¶

func (q Query) IncludeItems() []string

func (Query) Search ¶

func (q Query) Search(query string) Query

func (Query) SearchQuery ¶

func (q Query) SearchQuery() string

func (Query) Skip ¶

func (q Query) Skip(count int) Query

func (Query) SkipCount ¶

func (q Query) SkipCount() int

func (Query) Sort ¶

func (q Query) Sort(field string, function SortFunction) Query

func (Query) SortClauses ¶

func (q Query) SortClauses() []*SortClause

func (Query) String ¶

func (q Query) String() string

func (Query) Take ¶

func (q Query) Take(count int) Query

func (Query) TakeCount ¶

func (q Query) TakeCount() int

type SortClause ¶

type SortClause struct {
	Field    string
	Function SortFunction
}

func (SortClause) String ¶

func (c SortClause) String() string

type SortFunction ¶

type SortFunction string

const (
	ASC  SortFunction = "asc"
	DESC SortFunction = "desc"
)

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
examples

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL