query

package

Go to main page

Versions in this module

v0

v0.3.0

May 26, 2026

v0.2.0

May 19, 2026

Changes in this version

+ func EncodeCursor(createdAt time.Time, id string, params map[string]string) string

v0.1.2

May 25, 2026

v0.1.1

May 25, 2026

Changes in this version

+ func AggregationsToURLValues(aggs []Aggregation) url.Values

+ func BucketToURLValue(d time.Duration) string

+ func GroupToURLValue(group []string) string

+ func OrGroupsToURLValues(groups []Filters[any]) url.Values

+ type AggOp uint

+ const AggAvg

+ const AggCount

+ const AggMax

+ const AggMin

+ const AggSum

+ const AggUndefined

+ func (op AggOp) String() string

+ func (op AggOp) Valid() bool

+ type Aggregation struct

+ Alias string

+ Field string

+ Operator AggOp

type Option

+ func Aggregate(alias string, op AggOp, field string) Option

+ func Bucket(d time.Duration) Option

+ func Group(dimensions ...string) Option

+ func OrGroup(opts ...Option) Option

type Query

+ Aggregations func() []Aggregation

+ Bucket func() time.Duration

+ Group func() []string

+ OrGroups func() []Filters[any]

type ValidationOpt

+ func AggregationFields(fs ...string) ValidationOpt

+ func GroupFields(fs ...string) ValidationOpt

v0.1.0

May 22, 2026

Changes in this version

+ const FieldNameIncludes

+ const FieldNamePagination

+ const FieldNameQuery

+ const FieldNameSorting

+ var ErrInvalidFilterFormat = errors.New("filter format should be filter[field][operator]")

+ var ErrInvalidOperator = errors.New("invalid operator")

+ var OperatorStrings = map[filter.Operator]string

+ var Operators = map[string]filter.Operator

+ func AddFilter(q Query, operator filter.Operator, name string, val any)

+ func AddFilterParam(queryParams url.Values, fieldName string, operator filter.Operator, ...)

+ func DecodePositionCursor(encoded string) (time.Time, string)

+ func DoesInclude(q Query, relationship string) bool

+ func EncodePositionCursor(createdAt time.Time, id string) string

+ func FiltersToURLValues(filters Filters[any]) url.Values

+ func FormatNextURL[R resource.Resource](ctx context.Context, r []R, req protoreflect.ProtoMessage) string

+ func GetFilterSingleOrArrayVal[T any](fName string, filters Filters[any]) []T

+ func GetFilterValOrDefault[T any](fName string, filters Filters[any], def T) T

+ func GetFilterVal[T any](fName string, filters Filters[any]) T

+ func MarshalOperator(op filter.Operator) string

+ func PaginationToURLValues(p *PaginationParams) url.Values

+ func ParseOperator(val string) filter.Operator

+ func SortingToURLValue(sp *SortingParams) string

+ func SparseFieldsetsToURLValues(fields SparseFieldsets) url.Values

+ func UpdateFilter[T any](q Query, name string, ...)

+ func Validate(q Query, opts ...ValidationOpt) error

+ type Cursor interface

+ CreatedAt func() time.Time

+ Limit func() int

+ UUID func() string

+ func NewCursor(createdAt time.Time, uuid string, limit int) Cursor

+ type Filters map[string]filter.FieldFilter[T]

+ func (qf Filters[T]) Delete(key string)

+ func (qf Filters[T]) Exists(keys ...string) bool

+ func (qf Filters[T]) Get(key string) filter.FieldFilter[T]

+ type Option func(q *query)

+ func CursorPagination(before, after string, size int) Option

+ func Fields(resourceType string, names ...string) Option

+ func Filter(f filter.FieldFilter[any]) Option

+ func FilterBy(op filter.Operator, fieldName, val any) Option

+ func FilterByTriples(opFieldVals ...any) Option

+ func IncludedResourceObjects(relationshipNames ...string) Option

+ func Pagination(limit, offset int) Option

+ func ParseOptsFromHTTPReq(r *http.Request, opts ...ParseOpt) ([]Option, error)

+ func ParseURLQueryOpts(uri *url.URL, parseOpts ...ParseOpt) ([]Option, error)

+ func SortBy(sortParams ...any) Option

+ type PaginationParams struct

+ After string

+ Before string

+ Limit int

+ Offset int

+ Size int

+ func (p *PaginationParams) Delete()

+ func (p *PaginationParams) IsCursor() bool

+ type ParseOpt func(c *parseConfig)

+ func DefaultPagination(applied bool) ParseOpt

+ func SkipDefaultPagination() ParseOpt

+ type Query interface

+ Equal func(another Query) bool

+ Fields func() SparseFieldsets

+ Filters func() Filters[any]

+ IncludedResourceObjects func() []string

+ Merge func(q Query)

+ Pagination func() *PaginationParams

+ Sorting func() *SortingParams

+ func New(opts ...Option) Query

+ type SortingDir uint

+ const SortAsc

+ const SortDesc

+ const SortDirUndefined

+ func (sd SortingDir) String() string

+ func (sd SortingDir) Valid() bool

+ type SortingParams struct

+ func (sp *SortingParams) Get(key string) SortingDir

+ func (sp *SortingParams) Keys() []string

+ func (sp *SortingParams) Set(key string, v SortingDir)

+ type SparseFieldsets map[string][]string

+ type ValidationFunc func(f filter.FieldFilter[any]) error

+ type ValidationOpt func(c *validator) error

+ func AtLeastOneFilter() ValidationOpt

+ func GroupedFilters(fs ...string) ValidationOpt

+ func MandatoryFilters(fs ...string) ValidationOpt

+ func OptionalFilters(fs ...string) ValidationOpt

+ func SortFields(fs ...string) ValidationOpt

+ func ValidFilter(field string, fs ...ValidationFunc) ValidationOpt

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