query

Documentation

Index

• Constants
• Variables
• func EncodeFilter(fe FilterExpression) ([]byte, error)
• func EncodeRequest(req *http.Request, qry Interface) error
• func ToParams(params Interface) (*api.ListItemsParams, error)
• type Builder
  • func NewBuilder() Builder
• type FilterExpression
  • func DecodeFilter(str string) (FilterExpression, error)
  • func Junction(op Op, sub ...FilterExpression) FilterExpression
  • func Not(expr FilterExpression) FilterExpression
  • func SimpleExpr(name string, op Op, val interface{}) FilterExpression
• type Interface
  • func FromParams(params api.ListItemsParams) (Interface, error)
• type Op
• type Order
  • func OrderBy(name string, asc bool) Order
• type Orders
  • func (o Orders) String() string
• type Paging
  • func Page(offset uint64, count int) Paging

Constants

const (
	DefaultPageOffset = 0
	DefaultPageSize   = 20
)

const (
	OpAnd = Op("AND")
	OpOr  = Op("OR")
	OpNot = Op("NOT")
	OpEq  = Op("=")
)

Variables

var (
	DefaultPaging = Page(DefaultPageOffset, DefaultPageSize)
	DefaultFilter = SimpleExpr("1", OpAnd, "1")
	DefaultQuery  = &qryData{
		filter: DefaultFilter,
		paging: DefaultPaging,
	}
)

Functions

func EncodeFilter

func EncodeFilter(fe FilterExpression) ([]byte, error)

func EncodeRequest

func EncodeRequest(req *http.Request, qry Interface) error

func ToParams

func ToParams(params Interface) (*api.ListItemsParams, error)

Types

type Builder

type Builder interface {
	OrderBy(string, bool) Builder
	Paging(int, int) Builder
	Filter(FilterExpression) Builder
	Build() Interface
}

func NewBuilder

func NewBuilder() Builder

type FilterExpression

type FilterExpression interface {
	fmt.Stringer
}

func DecodeFilter

func DecodeFilter(str string) (FilterExpression, error)

func Junction

func Junction(op Op, sub ...FilterExpression) FilterExpression

func Not

func Not(expr FilterExpression) FilterExpression

func SimpleExpr

func SimpleExpr(name string, op Op, val interface{}) FilterExpression

type Interface

type Interface interface {
	fmt.Stringer
	Orders() Orders
	Paging() Paging
	Filter() FilterExpression
}

func FromParams

func FromParams(params api.ListItemsParams) (Interface, error)

type Op

type Op string

type Order

type Order interface {
	Name() string
	Asc() bool
}

func OrderBy

func OrderBy(name string, asc bool) Order

type Orders

type Orders []Order

func (Orders) String

func (o Orders) String() string

type Paging

type Paging interface {
	fmt.Stringer
	Offset() uint64
	Size() int
}

func Page

func Page(offset uint64, count int) Paging