| Step | name | kind | reference | javadoc | text | test | level |
|---|
| Gremlin | addE | sideEffect | addedge-step | addE-java.lang.String- | is used to add edges to the graph | | 2 |
| Gremlin | addV | sideEffect | addvertex-step | addV-java.lang.String- | is used to add vertices to the graph | | 2 |
| Gremlin | aggregate | sideEffect | aggregate-step | aggregate-java.lang.String- | is used to aggregate all the objects at a particular point of traversal into a Collection | | 2 |
| Gremlin | and | filter | and-step | and-org.apache.tinkerpop.gremlin.process.traversal.Traversal...- | ensures that all provided traversals yield a result | | 2 |
| Gremlin | as | modulator | as-step | as-java.lang.String-java.lang.String...- | is not a real step, but a "step modulator" similar to by() and option(). With as(), it is possible to provide a label to the step that can later be accessed by steps and data structures that make use of such labels — e.g., select(), match(), and path | | 2 |
| Gremlin | both | flatMap | | | maps the current elements to the vertices at the boths ends of the edges. | | 2 |
| Gremlin | bothE | flatMap | | | maps the current elements to both the in and outgoing edges. | | 2 |
| Gremlin | bothV | flatMap | | | maps the current edges to both the ingoing and outgoing Vertices. | | 2 |
| Gremlin | branch | general | general-steps | | Splits the traverser | | 2 |
| Gremlin | by | modulator | by-step | by-- | is not an actual step, but instead is a "step-modulator" similar to as() and option(). If a step is able to accept traversals, functions, comparators, etc. then by() is the means by which they are added. The general pattern is step().by()…by(). Some steps can only accept one by() while others can take an arbitrary amount. | | 2 |
| Gremlin | cap | barrier | cap-step | cap-java.lang.String-java.lang.String...- | Iterates the traversal up to the itself and emits the side-effect referenced by the key. If multiple keys are supplied then the side-effects are emitted as a Map. | | 3 |
| Gremlin | choose | branch | choose-step | choose-java.util.function.Function-,choose-java.util.function.Predicate-org.apache.tinkerpop.gremlin.process.traversal.Traversal- | routes the current traverser to a particular traversal branch option. With choose(), it is possible to implement if/then/else-semantics as well as more complicated selections. | | 2 |
| Gremlin | coalesce | flatMap | coalesce-step | | The coalesce()-step evaluates the provided traversals in order and returns the first traversal that emits at least one element. | | 2 |
| Gremlin | coin | filter | coin-step | coin-double- | randomly filters out traversers with the given probability | | 2 |
| Gremlin | count | reducing barrier | count-step | count-- | counts the total number of represented traversers in the streams (i.e. the bulk count). | | 3 |
| Gremlin | emit | modulator | emit-step | emit-- | is not an actual step, but is instead a step modulator for repeat() (find more documentation on the emit() there). | | 2 |
| Gremlin | explain | terminal | terminal-steps | | will return a TraversalExplanation. A traversal explanation details how the traversal (prior to explain()) will be compiled given the registered traversal strategies. A TraversalExplanation has a toString() representation with 3-columns. The first column is the traversal strategy being applied. The second column is the traversal strategy category: [D]ecoration, [O]ptimization, [P]rovider optimization, [F]inalization, and [V]erification. Finally, the third column is the state of the traversal post strategy application. The final traversal is the resultant execution plan. | | 2 |
| Gremlin | fill | terminal | terminal-steps | | fill(collection) will put all results in the provided collection and return the collection when complete. | | 2 |
| Gremlin | filter | general | general-steps | | Continues processing based on the given filter condition. | | 2 |
| Gremlin | flatMap | general | general-steps | | transforms the current step in a one to many fashion. | | 2 |
| Gremlin | fold | reducing barrier | fold-step | | There are situations when the traversal stream needs a "barrier" to aggregate all the objects and emit a computation that is a function of the aggregate. The fold()-step (map) is one particular instance of this. Please see unfold()-step for the inverse functionality. | | 3 |
| Gremlin | has | filter | has-step | has-java.lang.String- | filters vertices, edges, and vertex properties based on their properties. This step has quite a few variations. | | 2 |
| Gremlin | hasNext | terminal | terminal-steps | | determines whether there are available results | | 2 |
| Gremlin | id | map | id-step | | maps the traversal to the ids of the current elements. | | 2 |
| Gremlin | in | flatMap | | | maps the current elements to the vertices at the end of the ingoing edges. | | 2 |
| Gremlin | inE | flatMap | | | maps the current elements to the the ingoing edges. | | 2 |
| Gremlin | inV | flatMap | | | maps the current edges to the the ingoing Vertices. | | 2 |
| Gremlin | is | filter | is-step | is-org.apache.tinkerpop.gremlin.process.traversal.P- | filters elements that fullfill the given predicate. Variant: Filters elements that are equal to the given Object. | | 2 |
| Gremlin | iterate | terminal | terminal-steps | | Iterates the traversal presumably for the generation of side-effects. See https://stackoverflow.com/questions/47403296/iterate-step-is-used-in-the-end-of-the-command-when-creating-nodes-and-edges-t | | 2 |
| Gremlin | label | map | label-step | | maps the traversal to the labels of the current elements. | | 2 |
| Gremlin | limit | filter | limit-step | | | | |
| Gremlin | map | general | general-steps | | transforms the current step element to a new element (which may be empty).
see also https://stackoverflow.com/questions/51015636/in-gremlin-how-does-map-really-work | | 2 |
| Gremlin | match | map | match-step | | see https://stackoverflow.com/questions/55609832/is-threre-a-document-about-how-gremlin-match-works | | 2 |
| Gremlin | max | reducing barrier | max-step | | operates on a stream of comparable objects and determines which is the last object according to its natural order in the stream. | | 3 |
| Gremlin | mean | reducing barrier | mean-step | | operates on a stream of numbers and determines the average of those numbers. | | 3 |
| Gremlin | min | reducing barrier | min-step | | operates on a stream of comparable objects and determines which is the first object according to its natural order in the stream. | | 3 |
| Gremlin | next | terminal | terminal-steps | | will return the next result.next(n) will return the next n results in a list | | 2 |
| Gremlin | option | modulator | option-step | | An option to a branch() or choose() | | 2 |
| Gremlin | or | filter | or-step | or-org.apache.tinkerpop.gremlin.process.traversal.Traversal...- | ensures that at least one of the provided traversals yield a result. | | 2 |
| Gremlin | order | map | order-step | order--,order-org.apache.tinkerpop.gremlin.process.traversal.Scope- | orders the traversal elements | | 2 |
| Gremlin | out | flatMap | | | maps the current elements to the vertices at the end of the outgoing edges. | | 2 |
| Gremlin | outE | flatMap | | | maps the current elements to the the outgoing edges. | | 2 |
| Gremlin | outV | flatMap | | | The outV step maps the current edges to the outgoing Vertices. | | 2 |
| Gremlin | path | map | path-step | | | | 2 |
| Gremlin | promise | terminal | terminal-steps | | can only be used with remote traversals to Gremlin Server or RGPs. It starts a promise to execute a function on the current Traversal that will be completed in the future. | | 2 |
| Gremlin | property | sideEffect | addproperty-step | property-java.lang.Object-java.lang.Object-java.lang.Object...- | is used to add properties to the elements of the graph | | 2 |
| Gremlin | range | filter | range-step | | | | |
| Gremlin | repeat | branch | repeat-step | repeat-org.apache.tinkerpop.gremlin.process.traversal.Traversal-,repeat-java.lang.String-org.apache.tinkerpop.gremlin.process.traversal.Traversal- | is used for looping over a traversal given some break predicate | | 2 |
| Gremlin | select | map | select-step | | | | 2 |
| Gremlin | sideEffect | general | general-steps | | performs some operation on the traverser and passes it to the next step. | | 2 |
