Repository: tinkerpop Updated Branches: refs/heads/TINKERPOP-1975-x 8ced62095 -> 19e723d94
wip Project: http://git-wip-us.apache.org/repos/asf/tinkerpop/repo Commit: http://git-wip-us.apache.org/repos/asf/tinkerpop/commit/c1cf4105 Tree: http://git-wip-us.apache.org/repos/asf/tinkerpop/tree/c1cf4105 Diff: http://git-wip-us.apache.org/repos/asf/tinkerpop/diff/c1cf4105 Branch: refs/heads/TINKERPOP-1975-x Commit: c1cf4105c6c4cbe1ab4e8abdd7f5c167bab2f9a1 Parents: 8ced620 Author: Stephen Mallette <[email protected]> Authored: Thu May 31 15:11:42 2018 -0400 Committer: Stephen Mallette <[email protected]> Committed: Thu May 31 15:11:42 2018 -0400 ---------------------------------------------------------------------- docs/src/upgrade/release-3.4.x.asciidoc | 35 ++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/c1cf4105/docs/src/upgrade/release-3.4.x.asciidoc ---------------------------------------------------------------------- diff --git a/docs/src/upgrade/release-3.4.x.asciidoc b/docs/src/upgrade/release-3.4.x.asciidoc index 3c881c3..91668af 100644 --- a/docs/src/upgrade/release-3.4.x.asciidoc +++ b/docs/src/upgrade/release-3.4.x.asciidoc @@ -29,6 +29,30 @@ Please see the link:https://github.com/apache/tinkerpop/blob/3.4.0/CHANGELOG.asc === Upgrading for Users +==== with() Step + +This version of TinkerPop introduces the `with()` step to Gremlin. It isn't really a step but is instead a step +modulator. This modulator allows the step it is modifying to accept configurations that can be used to alter the +behavior of the step itself. A good example of its usage is shown with the revised syntax of the `pageRank()` step +which now uses `with()` to replace the old `by()` options: + +[groovy] +---- +g.V().hasLabel('person'). + pageRank(). + with(PageRank.EDGES, __.outE('knows')). + with(PageRank.PROPERTY_NAME, 'friendRank'). + order(). + by('friendRank',desc). + valueMap('name','friendRank') +---- + +Note that the `by()` modulators still work, but should be considered deprecated and open for removal in a future +release where breaking changes are allowed. + +See: link:https://issues.apache.org/jira/browse/TINKERPOP-1975[TINKERPOP-1975], +link:http://tinkerpop.apache.org/docs/current/reference/#with-step[Reference Documentation] + ==== Removal of Giraph Support Support for Giraph has been removed as of this version. There were a number of reasons for this decision which were @@ -198,6 +222,17 @@ See: link:https://issues.apache.org/jira/browse/TINKERPOP-1522[TINKERPOP-1522] ==== Graph Database Providers +===== Configuring Interface + +There were some changes to interfaces that were related to `Step`. A new `Configuring` interface was added that was +helpful in the implementation of the `with()` step modulator. This new interface extends the `Parameterizing` interface +(which moved to the `org.apache.tinkerpop.gremlin.process.traversal.step` package with the other step interfaces) and +in turn is extended by the `Mutating` interface. Making this change meant that the `Mutating.addPropertyMutations()` +method could be removed in favor of the new `Configuring.configure()` method. + +All of the changes above basically mean, that if the `Mutating` interface was being used in prior versions, the +`addPropertyMutations()` method simply needs to be changed to `configure()`. + ===== Removed hadoop-gremlin Test Artifact The `hadoop-gremlin` module no longer generates a test jar that can be used as a test dependency in other modules.
