filter

package

Go to main page

Versions in this module

v0

v0.13.0

Nov 9, 2026

Changes in this version

+ func FacetKeys(v any, f *FieldSchema) ([]string, error)

+ func OrderByKeys(d Dialect, keys []CursorKey, reverse bool) string

+ func SeekPredicate(d Dialect, keys []CursorKey, token *PageToken, bind func(any) string) (string, error)

type BuildFacetQueryOption

+ func WithFacetFrom(from string) BuildFacetQueryOption

+ type Document struct

+ func DecodeDocument(data []byte) (Document, error)

+ func (d Document) Root() any

v0.12.0

Nov 9, 2026

Changes in this version

+ const DefaultContainmentMaxValues

+ func ColumnValue(f *FieldSchema, v any) (any, bool, error)

+ type ColumnRow func(column string) (value any, ok bool)

+ func (r ColumnRow) Value(f *FieldSchema) (any, bool, error)

type Dialect

+ DecimalColumn func(column string) string

+ DecimalOrder func(value string) string

type FieldSchema

+ Element *FieldSchema

type PathDecl

+ Elem core.FieldType

type PostgresDialect

+ ContainmentMaxValues int

+ func (PostgresDialect) DecimalColumn(column string) string

+ func (PostgresDialect) DecimalOrder(value string) string

+ func (d PostgresDialect) TwoValuedCondition(field *FieldSchema, op FilterOperator, value any, bind func(any) string) (string, bool, error)

+ type Row interface

+ Value func(f *FieldSchema) (v any, present bool, err error)

+ type RowFunc func(f *FieldSchema) (any, bool, error)

+ func (r RowFunc) Value(f *FieldSchema) (any, bool, error)

type SQLiteDialect

+ func (SQLiteDialect) DecimalColumn(column string) string

+ func (SQLiteDialect) DecimalOrder(value string) string

+ type Truth uint8

+ const False

+ const True

+ const Unknown

+ func Evaluate(root *FilterNode, row Row) (Truth, error)

+ func (t Truth) String() string

+ type TwoValuedDialect interface

+ TwoValuedCondition func(field *FieldSchema, op FilterOperator, value any, bind func(any) string) (sql string, ok bool, err error)

v0.11.0

Nov 8, 2026

v0.10.1

Nov 6, 2026

v0.10.0

Nov 6, 2026

v0.9.0

Nov 4, 2026

v0.8.0

Nov 2, 2026

v0.7.0

Oct 29, 2026

v0.6.0

Oct 29, 2026

v0.5.0

Oct 29, 2026

v0.4.0

Oct 29, 2026

Changes in this version

type Dialect

+ DecimalParam func(placeholder string) string

type PostgresDialect

+ func (PostgresDialect) DecimalParam(placeholder string) string

type SQLiteDialect

+ func (SQLiteDialect) DecimalParam(placeholder string) string

v0.3.0

Oct 27, 2026

v0.2.0

Oct 26, 2026

v0.1.0

Oct 25, 2026

Changes in this version

+ const DefaultListLimit

+ const DefaultMaxIncludePerRelation

+ const ECodeArrayTooLarge

+ const ECodeCursorTooLarge

+ const ECodeDepthExceeded

+ const ECodeGeoNotSupported

+ const ECodeInputTooLarge

+ const ECodeInvalidArray

+ const ECodeInvalidCursor

+ const ECodeInvalidDistance

+ const ECodeInvalidEnumValue

+ const ECodeInvalidGeoCoords

+ const ECodeInvalidGeoPolygon

+ const ECodeInvalidJSON

+ const ECodeInvalidListParam

+ const ECodeInvalidOperator

+ const ECodeInvalidRelation

+ const ECodeInvalidUUID

+ const ECodeMaxConditions

+ const ECodeQueryTooExpensive

+ const ECodeSQLGenerationFailed

+ const ECodeSchemaNotFound

+ const ECodeSortFieldLimit

+ const ECodeSortFieldNotAllowed

+ const ECodeUnknownField

+ const ECodeValueTypeMismatch

+ const MaxIncludes

+ const MaxListLimit

+ const MaxPathDepth

+ const MaxRelationDepth

+ const MaxRelationPredicates

+ const ParamCursor

+ const ParamFacets

+ const ParamFields

+ const ParamFilter

+ const ParamInclude

+ const ParamIncludeDeleted

+ const ParamIncludeTotal

+ const ParamPageSize

+ const ParamSearch

+ const ParamSort

+ var CollationC = PostgresCollation

+ var CollationPgCUTF8 = PostgresCollation

+ var ErrUnknownDSN = dialect.ErrUnknownDSN

+ var ErrUnsupportedDialect = errors.New("unsupported SQL dialect")

+ var OperatorFromString = map[string]FilterOperator

+ var ValidFilterOps = map[FilterOperator]bool

+ func AllOperatorStrings() []string

+ func AndSearch(schema *SearchSchema, d Dialect, where string, args []any, offset int, ...) (string, []any, error)

+ func Codes() []core.Code

+ func CompareKeyValues(k CursorKey, a, b any) int

+ func CursorValue(v any) (any, error)

+ func CursorValueByTag(entity any, tagKey, tagValue string) (any, error)

+ func DefaultFilterOps() map[core.FieldType][]FilterOperator

+ func DocumentElements(doc any) ([]any, error)

+ func EncodeCursor(token *PageToken) (string, error)

+ func EscapeLike(s string) string

+ func FacetMap(results []FacetResult) map[string][]FacetBucket

+ func FieldExpr(d Dialect, f *FieldSchema) string

+ func IsListParam(name string) bool

+ func JSONContains(doc, needle any) bool

+ func JSONEqual(a, b any) bool

+ func JSONHasKey(doc any, key string) bool

+ func KeyValue(k CursorKey, raw any) (any, error)

+ func MatchLike(s, pattern string, fold bool) bool

+ func MatchLookupRow(cond *LookupCond, column func(name string) (value any, ok bool)) (bool, error)

+ func ParseDistance(s string) (float64, error)

+ func ParseIncludeNames(schema *ResourceSchema, names []string) ([]string, error)

+ func ParseIncludes(schema *ResourceSchema, param string) ([]string, error)

+ func PathValue(doc any, f *FieldSchema) (any, bool, error)

+ func ResolveRelativeTime(s string, now time.Time) (t time.Time, isToken bool, err error)

+ func ToAnySlice(ss []string) []any

+ func ValidateCursor(token *PageToken, keys []CursorKey) error

+ func ValidateGeoBoundingBox(bb *GeoBoundingBox) error

+ func ValidateGeoPoint(lat, lon float64) error

+ func ValidateGeoPolygon(p *GeoPolygon) error

+ func VisibleRelated(field *FieldSchema, dialect Dialect, alias string, tenant any, ...) (string, error)

+ type BuildFacetQueryOption func(*facetConfig)

+ func WithFacetRelatedPolicies(policies map[string]*PolicyConstraints) BuildFacetQueryOption

+ func WithFacetTenant(value any) BuildFacetQueryOption

+ func WithFacetUnscopedRelations() BuildFacetQueryOption

+ type Cursor string

+ func (c Cursor) IsZero() bool

+ type CursorField struct

+ Direction SortDirection

+ Name string

+ Value any

+ type CursorKey struct

+ Column string

+ DataType core.FieldType

+ Direction SortDirection

+ Name string

+ Nullable bool

+ NumberKind reflect.Kind

+ Path *JSONPath

+ SQLExpr string

+ func Keyset(sort *SortResult, tieBreaker CursorKey) []CursorKey

+ type CursorPlan struct

+ HasCursor bool

+ Keys []CursorKey

+ Reverse bool

+ func (p CursorPlan) Token(reverse bool, get func(column string) (any, error)) (*PageToken, error)

+ type Dialect interface

+ CTEMaterializeHint func() string

+ CodePointOrder func(expr string) string

+ Condition func(field *FieldSchema, op FilterOperator, value any, bind func(any) string) (string, error)

+ NativeRowCompare func() bool

+ PathExpr func(p *JSONPath, t core.FieldType) string

+ ReadColumn func(column string, t core.SQLType) string

+ RowLock func() string

+ func DialectFromDSN(dsn string) (Dialect, error)

+ type FacetBucket struct

+ Count int64

+ Key string

+ func FacetBuckets(cfg *FacetSchema, counts map[string]int64, limit int) []FacetBucket

+ type FacetQuery struct

+ Args []any

+ SQL string

+ func BuildFacetQuery(schema *ResourceSchema, dialect Dialect, filterWhere string, filterArgs []any, ...) (FacetQuery, error)

+ type FacetRange struct

+ Key string

+ Max *float64

+ Min *float64

+ type FacetRequest struct

+ Field string

+ Limit int

+ type FacetResult struct

+ Buckets []FacetBucket

+ Field string

+ func ScanFacetUnion(rows Rows) ([]FacetResult, error)

+ type FacetSchema struct

+ Field string

+ Limit int

+ Ranges []FacetRange

+ SQLExpr string

+ Type FacetType

+ func ParseFacetTag(tag string) (*FacetSchema, error)

+ type FacetType string

+ const FacetTerms

+ const FacetTypeRange

+ type FieldSchema struct

+ AllowedOperators []FilterOperator

+ DataType core.FieldType

+ Description string

+ Elem core.FieldType

+ Elements *ResourceSchema

+ EnumValues []string

+ ExternalName string

+ FacetSchema *FacetSchema

+ Facetable bool

+ GeoConfig *GeoFieldConfig

+ Group string

+ Immutable bool

+ Includable bool

+ Indexed bool

+ Label string

+ NumberKind reflect.Kind

+ Order int

+ Path *JSONPath

+ Related *ResourceSchema

+ RelatedBy *FieldSchema

+ Relation *core.RelationSchema

+ SQLExpr string

+ Searchable bool

+ Storage JSONStorage

+ Validate func(value any) error

+ func (f *FieldSchema) AllowsOperator(op FilterOperator) bool

+ type FilterAST struct

+ Root *FilterNode

+ func ApplyPolicyConstraints(schema *ResourceSchema, userAST *FilterAST, pc *PolicyConstraints) (*FilterAST, error)

+ type FilterFieldMeta struct

+ Name string

+ Operators []string

+ Type string

+ type FilterMeta struct

+ Fields []FilterFieldMeta

+ func FilterMetaFromSchema(schema *ResourceSchema) *FilterMeta

+ type FilterNode struct

+ Children []*FilterNode

+ Field *FieldSchema

+ Member *Lookup

+ Op FilterOperator

+ RawArgs []any

+ RawSQL string

+ Value any

+ type FilterOperator string

+ const OpAnd

+ const OpContains

+ const OpEq

+ const OpExists

+ const OpGt

+ const OpGte

+ const OpHasKey

+ const OpILike

+ const OpIn

+ const OpIntersects

+ const OpIs

+ const OpIsNot

+ const OpLike

+ const OpLt

+ const OpLte

+ const OpMember

+ const OpNe

+ const OpNear

+ const OpNin

+ const OpNone

+ const OpNot

+ const OpNotNull

+ const OpNull

+ const OpOr

+ const OpRawSQL

+ const OpSome

+ const OpWithin

+ func OperatorsFor(dt core.FieldType, relation bool) []FilterOperator

+ type FilterParser struct

+ func NewFilterParser(schema *ResourceSchema, config *core.ParserConfig) *FilterParser

+ func (p *FilterParser) And(filters ...*FilterAST) (*FilterAST, error)

+ func (p *FilterParser) Parse(queryParam string) (*FilterAST, error)

+ func (p *FilterParser) ParseBytes(data []byte) (*FilterAST, error)

+ func (p *FilterParser) ParseMap(raw map[string]any) (*FilterAST, error)

+ type GeoBoundingBox struct

+ BottomRight GeoPoint

+ TopLeft GeoPoint

+ type GeoDistance struct

+ Distance string

+ Lat float64

+ Lon float64

+ type GeoFieldConfig struct

+ LatKey string

+ LonKey string

+ SRID int

+ StorageType GeoStorageType

+ type GeoPoint struct

+ Lat float64

+ Lon float64

+ type GeoPolygon struct

+ Points []GeoPoint

+ type GeoStorageType string

+ const GeoStorageGeography

+ const GeoStorageGeometry

+ const GeoStorageJSONB

+ type IncludeLookup interface

+ LookupPairs func(ctx context.Context, l *Lookup, ownerColumn string) (iter.Seq2[IncludePair, error], error)

+ type IncludePair struct

+ Owner any

+ Target any

+ type IncludeQuery struct

+ Args []any

+ Field string

+ Limit int

+ SQL string

+ Schema *core.RelationSchema

+ func BuildIncludeQuery(field *FieldSchema, dialect Dialect, ownerPKs []any, ...) (IncludeQuery, error)

+ func (q IncludeQuery) Scan(rows Rows) (IncludeRows, error)

+ type IncludeQueryOption func(*includeQueryConfig)

+ func WithIncludeRelatedPolicies(policies map[string]*PolicyConstraints) IncludeQueryOption

+ func WithIncludeTenant(value any) IncludeQueryOption

+ func WithIncludeUnscoped() IncludeQueryOption

+ func WithMaxIncludePerRelation(n int) IncludeQueryOption

+ type IncludeRows struct

+ IDs map[string][]string

+ Truncated []string

+ func ResolveInclude(ctx context.Context, field *FieldSchema, ownerPKs []any, lookup IncludeLookup, ...) (IncludeRows, error)

+ type JSONPath struct

+ Column string

+ Segments []string

+ Storage JSONStorage

+ type JSONStorage string

+ const StorageJSON

+ const StorageJSONB

+ const StorageText

+ type ListOption func(*listConfig)

+ func ListCursor(cursor string) ListOption

+ func ListFacets(fields ...string) ListOption

+ func ListFilter(filterJSON string) ListOption

+ func ListFilterAST(ast *FilterAST) ListOption

+ func ListLimit(limit int) ListOption

+ func ListMaxLimit(limit int) ListOption

+ func ListPolicy(pc *PolicyConstraints) ListOption

+ func ListRelatedPolicies(policies map[string]*PolicyConstraints) ListOption

+ func ListSearch(query string) ListOption

+ func ListSort(sortParam string) ListOption

+ func ListSortResult(sr *SortResult) ListOption

+ func ListStartParam(n int) ListOption

+ func ListTenant(value any) ListOption

+ func ListUnscopedRelations() ListOption

+ func ListWithCount(enable bool) ListOption

+ type ListQuery struct

+ func NewListQuery(filterSchema *ResourceSchema, sortSchema *SortSchema, dialect Dialect) *ListQuery

+ func (lq *ListQuery) Build(opts ...ListOption) (*ListResult, error)

+ func (lq *ListQuery) WithFilterConfig(config *core.ParserConfig) *ListQuery

+ func (lq *ListQuery) WithSearchSchema(schema *SearchSchema) *ListQuery

+ type ListResult struct

+ Args []any

+ CountArgs []any

+ CountSQL string

+ Cursor CursorPlan

+ Facets *FacetQuery

+ FetchLimit int

+ Fragment string

+ Limit int

+ OrderBy string

+ Sort *SortResult

+ Where string

+ type Lookup struct

+ Filter *ParsedFilter

+ Project string

+ Table string

+ Where *LookupCond

+ type LookupCond struct

+ And []*LookupCond

+ Column string

+ Lookup *Lookup

+ Op LookupOp

+ Or []*LookupCond

+ Value any

+ Values []any

+ func WhereAll(conds ...*LookupCond) *LookupCond

+ func WhereAny(conds ...*LookupCond) *LookupCond

+ func WhereEq(column string, v any) *LookupCond

+ func WhereIn(column string, vs ...any) *LookupCond

+ func WhereMember(column string, l *Lookup) *LookupCond

+ func WhereNotNull(column string) *LookupCond

+ func WhereNull(column string) *LookupCond

+ type LookupOp string

+ const LookupOpEq

+ const LookupOpIn

+ const LookupOpMember

+ const LookupOpNotNull

+ const LookupOpNull

+ type MembershipLookup interface

+ LookupValues func(ctx context.Context, l *Lookup) ([]any, error)

+ type Page struct

+ Facets map[string][]FacetBucket

+ Items []T

+ PageInfo PageInfo

+ Relations map[string]map[string][]string

+ Truncated map[string][]string

+ func NewPage[T any](items []T, limit int, plan CursorPlan, ...) (*Page[T], error)

+ func (p *Page[T]) SetInclude(field string, rows IncludeRows)

+ type PageInfo struct

+ EndCursor Cursor

+ HasNextPage bool

+ HasPrevPage bool

+ StartCursor Cursor

+ TotalCount *int64

+ type PageToken struct

+ Fields []CursorField

+ Reverse bool

+ func DecodeCursor(encoded string) (*PageToken, error)

+ type ParsedFilter struct

+ AST *FilterAST

+ ConditionCount int

+ EstimatedCost int

+ func NewParsedFilter(ast *FilterAST) *ParsedFilter

+ func ResolveMemberships(ctx context.Context, f *ParsedFilter, lookup MembershipLookup, ...) (*ParsedFilter, error)

+ func (f *ParsedFilter) AuditInfo() map[string]any

+ type PathDecl struct

+ Facet *FacetSchema

+ Indexed bool

+ Label string

+ Ops []FilterOperator

+ Path string

+ Sort bool

+ Type core.FieldType

+ type PolicyConstraint struct

+ Field string

+ Member *Lookup

+ Negate bool

+ Operator FilterOperator

+ RawArgs []any

+ RawSQL string

+ UnknownIfInvalid bool

+ Value any

+ func UnknownConstraint() *PolicyConstraint

+ type PolicyConstraints struct

+ And []*PolicyConstraints

+ Constraints []*PolicyConstraint

+ Not bool

+ Or []*PolicyConstraints

+ PolicyID string

+ Source string

+ func BuildBaseConstraints(tenantCol, tenantID, deleteCol string, includeSoftDeleted bool) *PolicyConstraints

+ func ComposeConstraints(scope RepositoryScope, governance, authz *PolicyConstraints) *PolicyConstraints

+ func (pc *PolicyConstraints) IsEmpty() bool

+ func (pc *PolicyConstraints) Merge(other *PolicyConstraints) *PolicyConstraints

+ type PostgresCollation struct

+ func (c PostgresCollation) String() string

+ type PostgresDialect struct

+ Collation PostgresCollation

+ func (PostgresDialect) CTEMaterializeHint() string

+ func (PostgresDialect) NativeRowCompare() bool

+ func (PostgresDialect) PathExpr(p *JSONPath, t core.FieldType) string

+ func (PostgresDialect) ReadColumn(column string, t core.SQLType) string

+ func (PostgresDialect) RowLock() string

+ func (d PostgresDialect) CodePointOrder(expr string) string

+ func (d PostgresDialect) Condition(field *FieldSchema, op FilterOperator, value any, bind func(any) string) (string, error)

+ func (d PostgresDialect) MarshalValue(value any, t core.TypeInfo) (any, error)

+ type QueryParamOption func(*queryParamConfig)

+ func QueryParamAccept(names ...string) QueryParamOption

+ func QueryParamConfig(cfg *core.ParserConfig) QueryParamOption

+ func QueryParamFieldsOnly() QueryParamOption

+ func QueryParamLenient() QueryParamOption

+ type QueryParamParser struct

+ func NewQueryParamParser(schema *ResourceSchema, opts ...QueryParamOption) *QueryParamParser

+ func (p *QueryParamParser) Parse(params url.Values) (*FilterAST, error)

+ func (p *QueryParamParser) ParseHTTP(r *http.Request) (*FilterAST, error)

+ type RelationLookup interface

+ LookupFilteredValues func(ctx context.Context, l *Lookup) ([]any, error)

+ type RepositoryScope struct

+ DeleteColumn string

+ IncludeDeleted bool

+ TenantColumn string

+ TenantID string

+ type ResolveOption func(*resolveConfig)

+ func ResolveRelatedPolicies(policies map[string]*PolicyConstraints) ResolveOption

+ func ResolveTenant(value any) ResolveOption

+ func ResolveUnscopedRelations() ResolveOption

+ type ResourceSchema struct

+ Fields map[string]*FieldSchema

+ Name string

+ PrimaryKey string

+ SystemFields map[string]*FieldSchema

+ func GenerateFilterSchema[T any](g *core.SchemaGenerator) (*ResourceSchema, error)

+ func (s *ResourceSchema) WithPaths(decls ...PathDecl) (*ResourceSchema, error)

+ type Rows interface

+ Err func() error

+ Next func() bool

+ Scan func(dest ...any) error

+ type SQLBuilder struct

+ func NewSQLBuilder(schema *ResourceSchema, dialect Dialect, opts ...SQLBuilderOption) *SQLBuilder

+ func (b *SQLBuilder) Build(ast *FilterAST) (*SQLResult, error)

+ type SQLBuilderOption func(*sqlBuilderConfig)

+ func WithStartParam(n int) SQLBuilderOption

+ func WithTenant(value any) SQLBuilderOption

+ func WithUnscopedRelations() SQLBuilderOption

+ type SQLResult struct

+ Args []any

+ ParamCount int

+ Where string

+ type SQLiteDialect struct

+ func (SQLiteDialect) CTEMaterializeHint() string

+ func (SQLiteDialect) CodePointOrder(expr string) string

+ func (SQLiteDialect) NativeRowCompare() bool

+ func (SQLiteDialect) PathExpr(p *JSONPath, t core.FieldType) string

+ func (SQLiteDialect) ReadColumn(column string, _ core.SQLType) string

+ func (SQLiteDialect) RowLock() string

+ func (d SQLiteDialect) Condition(field *FieldSchema, op FilterOperator, value any, bind func(any) string) (string, error)

+ func (d SQLiteDialect) MarshalValue(value any, t core.TypeInfo) (any, error)

+ type SearchField struct

+ Name string

+ SQLExpr string

+ Weight SearchWeight

+ type SearchSchema struct

+ Fields []SearchField

+ Language string

+ Param string

+ func GenerateSearchSchema[T any](g *core.SchemaGenerator) (*SearchSchema, error)

+ type SearchWeight string

+ const SearchWeightA

+ const SearchWeightB

+ const SearchWeightC

+ const SearchWeightD

+ type SortDirection string

+ const SortAsc

+ const SortDesc

+ func ReverseDirection(d SortDirection) SortDirection

+ type SortField struct

+ Direction SortDirection

+ Name string

+ Schema *SortFieldSchema

+ type SortFieldSchema struct

+ Column string

+ DataType core.FieldType

+ Indexed bool

+ Nullable bool

+ NumberKind reflect.Kind

+ Path *JSONPath

+ SQLExpr string

+ func (s *SortFieldSchema) RowColumn() string

+ type SortResult struct

+ Fields []SortField

+ func ParseSort(schema *SortSchema, sortParam string) (*SortResult, error)

+ func (s *SortResult) ToSQL(d Dialect) string

+ type SortSchema struct

+ DefaultDir SortDirection

+ DefaultField string

+ Fields map[string]*SortFieldSchema

+ MaxFields int

+ func GenerateSortSchema[T any](g *core.SchemaGenerator) (*SortSchema, error)

+ func (s *SortSchema) WithPaths(fields *ResourceSchema, decls ...PathDecl) (*SortSchema, error)

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