fq

package
v1.19.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 14, 2025 License: MIT Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type FilterQueryResult deprecated

type FilterQueryResult = Result

Type alias for the Result struct

Deprecated: Use Result instead.

type Result added in v1.15.0

type Result struct {
	Filters          bson.M   // Primary filters which are usually evaluated as the first stage of an aggregation query
	SecondaryFilters bson.M   // Secondary filters which are usually evaluated after any lookups
	Sorts            bson.M   // Fields to sort by, with 1 or 'asc' for ascending and -1 or 'desc' for descending
	Include          []string // Fields to populate/lookup in the result set
	Select           bson.M   // Fields to select in the result set
	Prepaginate      bool     // Whether to paginate the results before any lookups
	Page             int64    // The page number for pagination
	Limit            int64    // The page size for pagination
}

func Parse

func Parse(qs string) Result

Parses the given query string into a Elemental FilterQueryResult.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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