From 94f93055f5321a36f96b83fab1f380b6ae932e2c Mon Sep 17 00:00:00 2001 From: "Marko A. Rodriguez" Date: Wed, 12 Jul 2017 14:42:11 -0600 Subject: [PATCH] added references to thosee steps that support by(), to(), from(), and option(). as() was excluded as everything supports as. --- docs/src/reference/the-traversal.asciidoc | 26 +++++++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) diff --git a/docs/src/reference/the-traversal.asciidoc b/docs/src/reference/the-traversal.asciidoc index c54a9db1692..c7fbcde196d 100644 --- a/docs/src/reference/the-traversal.asciidoc +++ b/docs/src/reference/the-traversal.asciidoc @@ -425,6 +425,24 @@ g.V().group().by(bothE().count()).by(count()) <3> <2> `by('name')` will process the grouped elements by their name (*element property projection*). <3> `by(count())` will count the number of elements in each group (*traversal*). +The following steps all support `by()`-modulation. Note that the semantics of such modulation should be understood +on a step-by-step level and thus, as discussed in their respective section of the documentation. + +* <>: dedup on the results of a `by()`-modulation. +* <>: filter if the traverser's path is cyclic given `by()`-modulation. +* <>: filter if the traverser's path is simple given `by()`-modulation. +* <>: sample using the value returned by `by()`-modulation. +* <>: determine the predicate given the testing of the results of `by()`-modulation. +* <>: count those groups where the group keys are the result of `by()`-modulation. +* <>: create group keys and values according to `by()`-modulation. +* <>: order the objects by the results of a `by()`-modulation. +* <>: get the path of the traverser where each path element is `by()`-modulated. +* <>: project a map of results given various `by()`-modulations off the current object. +* <>: select path elements and transform them via `by()`-modulation. +* <>: get a tree of traversers objects where the objects have been `by()`-modulated. +* <>: aggregate all objects into a set but only store their `by()`-modulated values. +* <>: store all objects into a set but only store their `by()`-modulated values. + [[cap-step]] Cap Step ~~~~~~~~ @@ -724,6 +742,9 @@ The `from()`-step is not an actual step, but instead is a "step-modulator" simil <>. If a step is able to accept traversals or strings then `from()` is the means by which they are added. The general pattern is `step().from()`. See <>-step. +The list of steps that support `from()`-modulation are: <>, <>, + <>, and <>. + [[group-step]] Group Step ~~~~~~~~~~ @@ -1288,8 +1309,7 @@ g.V().hasLabel('person'). Option Step ~~~~~~~~~~~ -An option to a <> or <> - +An option to a <> or <>. [[optional-step]] Optional Step @@ -2253,6 +2273,8 @@ The `to()`-step is not an actual step, but instead is a "step-modulator" similar <>. If a step is able to accept traversals or strings then `to()` is the means by which they are added. The general pattern is `step().to()`. See <>-step. +The list of steps that support `to()`-modulation are: <>, <>, + <>, and <>. [[tree-step]] Tree Step