Documentation
¶
Overview ¶
Package canonical is the single source of the string vocabulary the serialization dialects (JSON, YAML, TOML, URL) all map through: operators ("eq", "ne", "gt", ...), sort directions ("asc", "desc"), nulls positions ("first", "last"), and aggregate functions. Add or rename a term here first so every dialect stays consistent. Data-store dialects (SQL, BSON) use their own target-specific representations and skip this package.
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 "first", "last", or "" for unspecified.
func FormatSortDirection ¶
func FormatSortDirection(d r3.SortDirection) string
FormatSortDirection 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 ("count", "count_distinct", "sum", "avg", "min", "max") to r3.AggregateFunc.
func ParseFilterOperator ¶
func ParseFilterOperator(s string) (r3.FilterOperatorSpec, error)
ParseFilterOperator parses a canonical operator string (the keys of operatorByName) to r3.FilterOperatorSpec.
func ParseNullsPosition ¶
func ParseNullsPosition(s string) r3.SortNullsPosition
ParseNullsPosition parses "first"/"last"; anything else is NullsPositionNotSpecified.
func ParseSortDirection ¶
func ParseSortDirection(s string) r3.SortDirection
ParseSortDirection parses "asc"/"desc"; anything else is SortDirectionUnspecified.
Types ¶
This section is empty.
Source Files