Documentation
¶
Overview ¶
Package canonical provides shared parse and format functions for the canonical string representations of r3 query components.
All serialization dialects (JSON, YAML, TOML) use the same canonical strings for operators ("eq", "ne", "gt", ...), sort directions ("asc", "desc"), and nulls positions ("first", "last"). This package centralizes that mapping.
Data store dialects (SQL, BSON) typically do not use this package as they have their own target-specific representations.
Index ¶
- func FormatAggregateFunc(fn r3.AggregateFunc) string
- func FormatFilterOperator(op r3.FilterOperatorSpec) string
- func FormatNullsPosition(p r3.SortNullsPosition) string
- func FormatSortDirection(d r3.SortDirection) string
- func ParseAggregateFunc(s string) (r3.AggregateFunc, error)
- func ParseFilterOperator(s string) (r3.FilterOperatorSpec, error)
- func ParseNullsPosition(s string) r3.SortNullsPosition
- func ParseSortDirection(s string) r3.SortDirection
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func FormatAggregateFunc ¶ added in v0.0.3
func FormatAggregateFunc(fn r3.AggregateFunc) string
FormatAggregateFunc returns the canonical string for an r3.AggregateFunc.
func FormatFilterOperator ¶
func FormatFilterOperator(op r3.FilterOperatorSpec) string
FormatFilterOperator returns the canonical string for an r3.FilterOperatorSpec.
func FormatNullsPosition ¶
func FormatNullsPosition(p r3.SortNullsPosition) string
FormatNullsPosition returns the canonical string for an r3.SortNullsPosition. Returns "first", "last", or "" for unspecified.
func FormatSortDirection ¶
func FormatSortDirection(d r3.SortDirection) string
FormatSortDirection returns the canonical string for an r3.SortDirection. Returns "asc", "desc", or "" for unspecified.
func ParseAggregateFunc ¶ added in v0.0.3
func ParseAggregateFunc(s string) (r3.AggregateFunc, error)
ParseAggregateFunc parses a canonical aggregate-function string to r3.AggregateFunc. Recognized strings: "count", "count_distinct", "sum", "avg", "min", "max".
func ParseFilterOperator ¶
func ParseFilterOperator(s string) (r3.FilterOperatorSpec, error)
ParseFilterOperator parses a canonical operator string to r3.FilterOperatorSpec. Recognized strings: "eq", "ne", "exists", "gt", "gte", "lt", "lte", "between", "between_exc", "between_exc_inc", "between_inc_exc", "in", "nin", "like", "notlike", "ilike".
func ParseNullsPosition ¶
func ParseNullsPosition(s string) r3.SortNullsPosition
ParseNullsPosition parses a canonical nulls position string. Recognized strings: "first", "last". Empty or unknown strings return NullsPositionNotSpecified.
func ParseSortDirection ¶
func ParseSortDirection(s string) r3.SortDirection
ParseSortDirection parses a canonical sort direction string. Recognized strings: "asc", "desc". Empty or unknown strings return SortDirectionUnspecified.
Types ¶
This section is empty.
Source Files