Documentation
¶
Overview ¶
Package condexpr defines a simple DSL for building structured, nested filter expressions. It supports logical operators (AND, OR) and standard comparison operators (=, !=, >, <, etc.). The expressions can be evaluated directly or translated into other languages such as SQL.
This package is designed for use across services that require programmatic filtering logic. It is not tied to a specific database or schema and can be extended to support additional operators or target languages.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DefaultBuild ¶
func DefaultBuild[T any, CB ConditionBuilder[T]](cb CB, cond Condition) (out T, err error)
DefaultBuild provides generic default processing and validation functionality for types implementing the ConditionBuilder.Build function.
It processes a given Condition and determines whether it represents a composite AND condition, a composite OR condition, or a valid leaf condition. Based on the type, it delegates the construction to the appropriate method of the ConditionBuilder.
The function also enforces that the Condition must specify exactly one of the following: - An AND condition (non-empty `And` field). - An OR condition (non-empty `Or` field). - A valid leaf condition (non-empty `Field`, `Operator`, or `Value` fields).
Types ¶
type Condition ¶
type Condition struct {
// Field is the name of the field to compare. Only used for leaf conditions.
Field string `json:"field,omitempty"`
// Operator is the comparison operator. Only used for leaf conditions.
Operator string `json:"op,omitempty"`
// Value is the value to compare against. Only used for leaf conditions.
// The type should match the field type being compared.
Value any `json:"value,omitempty"`
// And combines multiple conditions with logical AND.
// All conditions must be true for the AND to be true.
And []Condition `json:"and,omitempty"`
// Or combines multiple conditions with logical OR.
// At least one condition must be true for the OR to be true.
Or []Condition `json:"or,omitempty"`
}
Condition represents a filter expression that can be either a leaf condition or a logical composite condition.
type ConditionBuilder ¶
type ConditionBuilder[T any] interface { Build(cond Condition) (T, error) BuildCompositeAnd(cond Condition) (T, error) BuildCompositeOr(cond Condition) (T, error) BuildLeafCondition(cond Condition) (T, error) }
ConditionBuilder is an interface that can be implemented for specific use cases (e.g. to add support for building a SQL expression, etc).
Source Files
Directories