listquery

package

v0.145.0 Latest Latest Go to latest Published: Nov 11, 2026 License: MIT Imports: 6 Imported by: 0

Details

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

Repository

github.com/goliatone/go-admin

Links

Open Source Insights

Documentation ¶

Index ¶

func AtoiDefault(val string, def int) int
func MapPredicates[T any](predicates []Predicate, mapper func(Predicate) T) []T
func ParsePredicateKey(key string) (string, string)
func ToString(v any) string
func ValuesFromAny(raw any) []string
type Options
- func ParseOptions[T any](c router.Context, defaultPage, defaultPerPage int, mapper func(Predicate) T) Options[T]
- func ParsePanelOptions[T any](c router.Context, mapper func(Predicate) T) Options[T]
type Predicate
- func PredicatesFromFilters(filters map[string]any) []Predicate
type Result
- func ParseContext(c router.Context, defaultPage, defaultPerPage int) Result

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func AtoiDefault ¶

func AtoiDefault(val string, def int) int

AtoiDefault converts a string to int and returns def on parse failure.

func MapPredicates ¶

func MapPredicates[T any](predicates []Predicate, mapper func(Predicate) T) []T

MapPredicates projects parsed predicates into consumer-specific predicate types.

func ParsePredicateKey ¶

func ParsePredicateKey(key string) (string, string)

ParsePredicateKey splits filter keys like "title__ilike".

func ToString ¶

func ToString(v any) string

ToString converts common scalar values into string.

func ValuesFromAny ¶

func ValuesFromAny(raw any) []string

ValuesFromAny normalizes scalar/array filter values into a string slice.

Types ¶

type Options ¶

type Options[T any] struct {
	Page       int            `json:"page"`
	PerPage    int            `json:"per_page"`
	SortBy     string         `json:"sort_by"`
	SortDesc   bool           `json:"sort_desc"`
	Filters    map[string]any `json:"filters"`
	Predicates []T            `json:"predicates"`
	Fields     []string       `json:"fields"`
	Search     string         `json:"search"`
}

Options projects Result into consumer-specific predicate types. The field layout intentionally mirrors admin and boot list option structs.

func ParseOptions ¶

func ParseOptions[T any](c router.Context, defaultPage, defaultPerPage int, mapper func(Predicate) T) Options[T]

ParseOptions parses list query params and maps predicates into consumer-specific types.

func ParsePanelOptions ¶ added in v0.32.0

func ParsePanelOptions[T any](c router.Context, mapper func(Predicate) T) Options[T]

ParsePanelOptions parses list query params using the canonical go-admin panel defaults.

type Predicate ¶

type Predicate struct {
	Field    string   `json:"field"`
	Operator string   `json:"operator"`
	Values   []string `json:"values"`
}

Predicate describes a single parsed operator-aware filter.

func PredicatesFromFilters ¶

func PredicatesFromFilters(filters map[string]any) []Predicate

PredicatesFromFilters converts a filter map into normalized predicates.

type Result ¶

type Result struct {
	Page       int            `json:"page"`
	PerPage    int            `json:"per_page"`
	SortBy     string         `json:"sort_by"`
	SortDesc   bool           `json:"sort_desc"`
	Search     string         `json:"search"`
	Filters    map[string]any `json:"filters"`
	Predicates []Predicate    `json:"predicates"`
	Fields     []string       `json:"fields"`
}

Result captures normalized list query options.

func ParseContext ¶

func ParseContext(c router.Context, defaultPage, defaultPerPage int) Result

ParseContext extracts list query options from a router context.

Source Files ¶

View all Source files

parse.go

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