Documentation ¶
Index ¶
- Constants
- func EvaluateQuery(env envs.Environment, query *ContactQuery, queryable Queryable) bool
- func IsQueryError(err error) (bool, error)
- func Stringify(n QueryNode) string
- type BoolCombination
- type BoolOperator
- type Condition
- func (c *Condition) Operator() Operator
- func (c *Condition) PropertyKey() string
- func (c *Condition) PropertyType() PropertyType
- func (c *Condition) Simplify() QueryNode
- func (c *Condition) String() string
- func (c *Condition) Value() string
- func (c *Condition) ValueAsDate(env envs.Environment) (time.Time, error)
- func (c *Condition) ValueAsFlow(resolver Resolver) assets.Flow
- func (c *Condition) ValueAsGroup(resolver Resolver) assets.Group
- func (c *Condition) ValueAsNumber() (decimal.Decimal, error)
- type ContactQuery
- type Inspection
- type Operator
- type PropertyType
- type QueryError
- type QueryNode
- type Queryable
- type Resolver
Constants ¶
const ( ErrSyntax = "syntax" ErrInvalidNumber = "invalid_number" // `value` the value we tried to parse as a number ErrInvalidDate = "invalid_date" // `value` the value we tried to parse as a date ErrInvalidStatus = "invalid_status" // `value` the value we tried to parse as a contact status ErrInvalidLanguage = "invalid_language" // `value` the value we tried to parse as a language code ErrInvalidGroup = "invalid_group" // `value` the value we tried to parse as a group name ErrInvalidFlow = "invalid_flow" // `value` the value we tried to parse as a flow name ErrInvalidPartialName = "invalid_partial_name" // `min_token_length` the minimum length of token required for name contains condition ErrInvalidPartialURN = "invalid_partial_urn" // `min_value_length` the minimum length of value required for URN contains condition ErrUnsupportedContains = "unsupported_contains" // `property` the property key ErrUnsupportedComparison = "unsupported_comparison" // `property` the property key, `operator` one of =>, <, >=, <= ErrUnsupportedSetCheck = "unsupported_setcheck" // `property` the property key, `operator` one of =, != ErrUnknownPropertyType = "unknown_property_type" // `type` the property type ErrUnknownProperty = "unknown_property" // `property` the property key ErrRedactedURNs = "redacted_urns" )
error codes with values included in extra
const ( AttributeUUID = "uuid" AttributeID = "id" AttributeName = "name" AttributeStatus = "status" AttributeLanguage = "language" AttributeURN = "urn" AttributeGroup = "group" AttributeFlow = "flow" AttributeHistory = "history" AttributeTickets = "tickets" AttributeCreatedOn = "created_on" AttributeLastSeenOn = "last_seen_on" )
Fixed attributes that can be searched
Variables ¶
This section is empty.
Functions ¶
func EvaluateQuery ¶
func EvaluateQuery(env envs.Environment, query *ContactQuery, queryable Queryable) bool
EvaluateQuery evaluates the given query against the given queryable. That query must have been parsed with a resolver to ensure all fields and groups resolve. If not function panics.
func IsQueryError ¶ added in v0.94.1
IsQueryError is a utility to determine if the cause of an error was a query error
Types ¶
type BoolCombination ¶
type BoolCombination struct {
// contains filtered or unexported fields
}
BoolCombination is a AND or OR combination of multiple conditions
func NewBoolCombination ¶
func NewBoolCombination(op BoolOperator, children ...QueryNode) *BoolCombination
NewBoolCombination creates a new boolean combination
func (*BoolCombination) Children ¶ added in v0.41.15
func (b *BoolCombination) Children() []QueryNode
Children returns the children of this boolean combination
func (*BoolCombination) Operator ¶ added in v0.41.15
func (b *BoolCombination) Operator() BoolOperator
Operator returns the type of boolean operator this combination is
func (*BoolCombination) Simplify ¶ added in v0.162.0
func (b *BoolCombination) Simplify() QueryNode
func (*BoolCombination) String ¶
func (b *BoolCombination) String() string
type BoolOperator ¶ added in v0.41.15
type BoolOperator string
BoolOperator is a boolean operator (and or or)
const ( // BoolOperatorAnd is our constant for an AND operation BoolOperatorAnd BoolOperator = "and" // BoolOperatorOr is our constant for an OR operation BoolOperatorOr BoolOperator = "or" )
type Condition ¶
type Condition struct {
// contains filtered or unexported fields
}
Condition represents a comparison between a keywed value on the contact and a provided value
func NewCondition ¶ added in v0.162.0
func NewCondition(propType PropertyType, propKey string, operator Operator, value string) *Condition
func (*Condition) PropertyKey ¶ added in v0.45.1
PropertyKey returns the key for the property being queried
func (*Condition) PropertyType ¶ added in v0.45.1
func (c *Condition) PropertyType() PropertyType
PropertyType returns the type (attribute, scheme, field)
func (*Condition) ValueAsDate ¶ added in v0.98.0
ValueAsDate returns the value as a date if possible, or an error if not
func (*Condition) ValueAsFlow ¶ added in v0.151.0
ValueAsFlow returns the value as a flow if possible
func (*Condition) ValueAsGroup ¶ added in v0.99.0
ValueAsGroup returns the value as a group if possible
type ContactQuery ¶
type ContactQuery struct {
// contains filtered or unexported fields
}
ContactQuery is a parsed contact QL query
func ParseQuery ¶
func ParseQuery(env envs.Environment, text string, resolver Resolver) (*ContactQuery, error)
ParseQuery parses a ContactQL query from the given input. If resolver is provided then we validate against it to ensure that fields and groups exist. If not provided then still validate what we can.
func (*ContactQuery) Resolver ¶ added in v0.132.0
func (q *ContactQuery) Resolver() Resolver
Resolver returns the optional resolver this query was parsed with
func (*ContactQuery) Root ¶ added in v0.41.15
func (q *ContactQuery) Root() QueryNode
Root returns the root node of this query
func (*ContactQuery) String ¶
func (q *ContactQuery) String() string
String returns the pretty formatted version of this query
type Inspection ¶ added in v0.92.0
type Inspection struct { Attributes []string `json:"attributes"` Schemes []string `json:"schemes"` Fields []*assets.FieldReference `json:"fields"` Groups []*assets.GroupReference `json:"groups"` AllowAsGroup bool `json:"allow_as_group"` }
Inspection holds the result of inspecting a query
func Inspect ¶ added in v0.92.0
func Inspect(query *ContactQuery) *Inspection
Inspect extracts information about a query
type Operator ¶ added in v0.98.0
type Operator string
Operator is a comparison operation between two values in a condition
type PropertyType ¶ added in v0.45.1
type PropertyType string
PropertyType is the type of the lefthand side of a condition
const ( // PropertyTypeAttribute is builtin property PropertyTypeAttribute PropertyType = "attr" // PropertyTypeURN is a URN scheme PropertyTypeURN PropertyType = "urn" // PropertyTypeField is a custom contact field PropertyTypeField PropertyType = "field" )
type QueryError ¶ added in v0.92.0
type QueryError struct {
// contains filtered or unexported fields
}
QueryError is used when an error is a result of an invalid query
func NewQueryError ¶ added in v0.97.0
func NewQueryError(code, err string, args ...any) *QueryError
NewQueryError creates a new query error
func (*QueryError) Code ¶ added in v0.97.0
func (e *QueryError) Code() string
Code returns a code representing this error condition
func (*QueryError) Error ¶ added in v0.92.0
func (e *QueryError) Error() string
Error returns the error message
func (*QueryError) Extra ¶ added in v0.97.0
func (e *QueryError) Extra() map[string]any
Extra returns additional data about the error
type QueryNode ¶
type QueryNode interface { fmt.Stringer Simplify() QueryNode // contains filtered or unexported methods }
QueryNode is the base for nodes in our query parse tree
type Queryable ¶
type Queryable interface {
QueryProperty(envs.Environment, string, PropertyType) []any
}
Queryable is the interface objects must implement queried