Documentation
¶
Overview ¶
Package predicate contains the object to control the searching predicates of a graph traversal.
Predicates are used for when you're trying to narrow the search of a vertex or vertices on the graph without having to perform multiple searches.
A note about Predicate:
This object implements the Parameter interfaces used by graph traversals.
Index ¶
- type Predicate
- func Equal(val interface{}) *Predicate
- func GreaterThan(val interface{}) *Predicate
- func GreaterThanOrEqual(val interface{}) *Predicate
- func Inside(min, max interface{}) *Predicate
- func LessThan(val interface{}) *Predicate
- func LessThanOrEqual(val interface{}) *Predicate
- func NotEqual(val interface{}) *Predicate
- func TextContains(str string) *Predicate
- func TextContainsFuzzy(str string) *Predicate
- func TextContainsPrefix(str string) *Predicate
- func TextContainsRegex(str string) *Predicate
- func TextFuzzy(str string) *Predicate
- func TextPrefix(str string) *Predicate
- func TextRegex(str string) *Predicate
- func Within(params ...interface{}) *Predicate
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Predicate ¶
type Predicate string
Predicate is used when you're trying to find values like IDs or property values that meet within the criteria.
func Equal ¶
func Equal(val interface{}) *Predicate
Equal checks if this value is exactly equal to the querying value.
func GreaterThan ¶
func GreaterThan(val interface{}) *Predicate
GreaterThan checks if this value is greater than the querying value.
func GreaterThanOrEqual ¶
func GreaterThanOrEqual(val interface{}) *Predicate
GreaterThanOrEqual checks if this value is greater than or equal to the querying value.
func Inside ¶
func Inside(min, max interface{}) *Predicate
Inside checks if this value is within the minimum and maximum querying values.
func LessThan ¶
func LessThan(val interface{}) *Predicate
LessThan checks if this value is less than the querying value.
func LessThanOrEqual ¶
func LessThanOrEqual(val interface{}) *Predicate
LessThanOrEqual checks if this value is less than or equal to the querying value.
func NotEqual ¶
func NotEqual(val interface{}) *Predicate
NotEqual check if this value is NOT equal to the query value.
func TextContains ¶
TextContains finds if at least one word inside the text string matches the query string.
func TextContainsFuzzy ¶
TextContainsFuzzy finds if one word inside the text string is similar to the query string.
func TextContainsPrefix ¶
TextContainsPrefix finds if one word inside the text string begins with the query string.
func TextContainsRegex ¶
TextContainsRegex finds if one word inside the text string matches the given regular expression.
func TextPrefix ¶
TextPrefix finds if the string value starts with the given string.
func TextRegex ¶
TextRegex finds if the string value matches the given regular expression in its entirety.
Source Files