contactql

package
v0.183.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 7, 2023 License: AGPL-3.0, AGPL-3.0-or-later Imports: 15 Imported by: 2

Documentation

Index

Constants

View Source 
const (
	ErrUnexpectedToken       = "unexpected_token"       // `token` the unexpected token
	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 =, !=
	ErrUnknownProperty       = "unknown_property"       // `property` the property key
	ErrRedactedURNs          = "redacted_urns"
)

error codes with values included in extra

View Source 
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 

func IsQueryError(err error) (bool, error)

IsQueryError is a utility to determine if the cause of an error was a query error

func Stringify added in v0.162.0 

func Stringify(n QueryNode) string

Stringify converts a query node to a string

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(propKey string, propType PropertyType, operator Operator, value string) *Condition

func (*Condition) Operator added in v0.98.0 

func (c *Condition) Operator() Operator

Operator returns the type of comparison being made

func (*Condition) PropertyKey added in v0.45.1 

func (c *Condition) PropertyKey() string

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) Simplify added in v0.162.0 

func (c *Condition) Simplify() QueryNode

func (*Condition) String 

func (c *Condition) String() string

func (*Condition) Value added in v0.41.15 

func (c *Condition) Value() string

Value returns the value being compared against

func (*Condition) ValueAsDate added in v0.98.0 

func (c *Condition) ValueAsDate(env envs.Environment) (time.Time, error)

ValueAsDate returns the value as a date if possible, or an error if not

func (*Condition) ValueAsFlow added in v0.151.0 

func (c *Condition) ValueAsFlow(resolver Resolver) assets.Flow

ValueAsFlow returns the value as a flow if possible

func (*Condition) ValueAsGroup added in v0.99.0 

func (c *Condition) ValueAsGroup(resolver Resolver) assets.Group

ValueAsGroup returns the value as a group if possible

func (*Condition) ValueAsNumber added in v0.98.0 

func (c *Condition) ValueAsNumber() (decimal.Decimal, error)

ValueAsNumber returns the value as a number if possible, or an error if not

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 

const (
	OpEqual              Operator = "="
	OpNotEqual           Operator = "!="
	OpContains           Operator = "~"
	OpGreaterThan        Operator = ">"
	OpLessThan           Operator = "<"
	OpGreaterThanOrEqual Operator = ">="
	OpLessThanOrEqual    Operator = "<="
)

supported operators

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 = "attribute"

	// PropertyTypeScheme is a URN scheme
	PropertyTypeScheme PropertyType = "scheme"

	// 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 ...interface{}) *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]string

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) []interface{}
}

Queryable is the interface objects must implement queried

type Resolver added in v0.76.0 

type Resolver interface {
	ResolveField(key string) assets.Field
	ResolveGroup(name string) assets.Group
	ResolveFlow(name string) assets.Flow
}

Resolver provides functions for resolving assets referenced in queries

func NewMockResolver added in v0.76.0 

func NewMockResolver(fields []assets.Field, flows []assets.Flow, groups []assets.Group) Resolver

NewMockResolver creates a new mock resolver for fields and groups

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.