Types
Element: An element step reads vertices or edges from a graph.
Map: A map step maps input objects to other objects.
Filter: A filter step filters input objects.
sideEffect: A sideEffect step allows input objects to proceed unchanged, but generates some computational sideEffects in the process.
Branch: A branch step splits input objects and sends each to an arbitrary location in the traversal.
Modulator: A modulator step provides parameters for other steps.
Function: Functions are provided to steps. For example, comparison functions can be provided to filter steps.
Policy: Users can customize policies for traversal steps.
Description
Note: Steps that are marked with asterisks (*) are extended steps of iGraph. Other steps are open source Apache Gremlin steps.
Type | Step | Description |
Element | Reads edges from a graph. | |
Returns the vertices that are associated with an edge. | ||
Returns the vertices that are associated with a vertex | ||
Returns the edges that are associated with a vertex | ||
Reads vertices from a graph. | ||
Map | Serves as a barrier. | |
Returns the bulk value of an element. | ||
Returns the value of a sideEffect. | ||
Returns a custom constant value. | ||
Counts the number of input objects. | ||
Aggregates input objects into a list<object>. | ||
Groups input objects based on a specific rule. | ||
Groups input objects based on a specific rule and returns the number of objects in each group. | ||
Returns input objects. | ||
Returns the graph labels of elements. | ||
Returns the number of times that the current loop has been gone through. | ||
Performs scientific calculation. | ||
Returns the maximum value of input objects. | ||
Returns the average value of input objects. | ||
Returns the minimum value of input objects. | ||
Sorts input objects. | ||
Returns the path of a traversal. | ||
Maps input objects to a map<string,object>. | ||
Returns the properties of an element. | ||
Returns a map of the properties of an element. | ||
Returns the sack value of an element. | ||
Returns the objects with labels defined by an as() step. | ||
Sums input objects. | ||
Unfolds a list<object> to objects. | ||
Returns the values of properties of an element. | ||
Filter | Returns the input objects for which all child traversals have results. | |
Returns a cyclic path. | ||
Deduplicates input objects. | ||
distinct [*] | Hashes input objects based on a specific method and extracts a specific number of objects from each hash bucket. | |
Filters elements. | ||
Filters elements and returns the elements that meet the specified condition. | ||
Filters elements based on field names and returns the names and values of the fields that meet the specified condition. | ||
Filters elements based on labels and returns the elements that meet the specified condition. | ||
Filters elements based on field values and returns the names and values of the fields that meet the specified condition. | ||
Filters elements based on a number or string. | ||
Returns a specific number of the first elements. | ||
Returns the input objects for which a child traversal returns no results. | ||
Returns the input objects for which at least one child traversal has results. | ||
Returns the objects in a specific range. | ||
Samples objects. | ||
Returns a simple path. | ||
Returns a specific number of the last elements. | ||
Filters elements. | ||
sideEffect | Aggregates input objects into a list<object> with a barrier. | |
alias [*] | Defines virtual fields for input elements. | |
fields [*] | Retains the specified fields and removes other fields from elements. | |
Aggregates input objects into a list<object> without a barrier. | ||
Branch | Performs branching queries. | |
Performs branching queries. | ||
Evaluates the input traversals in sequence and returns the first traversal that finds at least one element. | ||
Runs a child traversal for each input object. | ||
Returns the result of a child traversal if the child traversal has a result. | ||
Loops over a traversal. | ||
Merges the results of child traversals. | ||
Modulator | Adds labels to input objects. | |
Provides parameters such as traversals, functions, and comparators for other steps. | ||
Returns the intermediate results of a loop. | ||
indexQuery [*] | Performs an inverted query. | |
Specifies an option for branching queries. | ||
Specifies the number of times that a loop is gone through. | ||
Specifies the condition to break a loop. | ||
Defines initial value supplier, split operator, and merge operator for the sack of each element. | ||
Function | Compares values. | |
Extracts the information about elements. | ||
UDF [*] | Uses a user-defined function (UDF). | |
Policy | Applies a custom policy to a traversal. | |
Specifies the type of information to be returned for a path. | ||
Pushes a sideEffect step to the storage layer for execution. |