TINKERPOP-2053 Added upgrade docs for OptionsStrategy
Project: http://git-wip-us.apache.org/repos/asf/tinkerpop/repo Commit: http://git-wip-us.apache.org/repos/asf/tinkerpop/commit/57f76f83 Tree: http://git-wip-us.apache.org/repos/asf/tinkerpop/tree/57f76f83 Diff: http://git-wip-us.apache.org/repos/asf/tinkerpop/diff/57f76f83 Branch: refs/heads/TINKERPOP-2053 Commit: 57f76f83a3d72316ffa8371fa93fddd10a83fb8e Parents: f134c8a Author: Stephen Mallette <sp...@genoprime.com> Authored: Tue Oct 2 13:55:21 2018 -0400 Committer: Stephen Mallette <sp...@genoprime.com> Committed: Fri Oct 5 10:30:19 2018 -0400 ---------------------------------------------------------------------- docs/src/upgrade/release-3.4.x.asciidoc | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/57f76f83/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 21e1899..a961575 100644 --- a/docs/src/upgrade/release-3.4.x.asciidoc +++ b/docs/src/upgrade/release-3.4.x.asciidoc @@ -483,6 +483,27 @@ All of the changes above basically mean, that if the `Mutating` interface was be See: link:https://issues.apache.org/jira/browse/TINKERPOP-1975[TINKERPOP-1975] +===== OptionsStrategy + +`OptionsStrategy` is a `TraversalStrategy` that makes it possible for users to set arbitrary configurations on a +`Traversal`. These configurations can be used by graph providers to allow for traversal-level configurations to be +accessible to their custom steps. A user would write something like: + +[source,java] +---- +g.withStrategies(OptionsStrategy.build().with("specialLimit", 10000).create()); +---- + +The graph provider could then access that value of "specialLimit" in their custom step (or elsewhere) as follows: + +[source,java] +---- +OptionsStrategy strategy = this.getTraversal().asAdmin().getStrategies().getStrategy(OptionsStrategy.class).get(); +int specialLimit = (int) strategy.getOptions().get("specialLimit"); +---- + +See: link:https://issues.apache.org/jira/browse/TINKERPOP-2053[TINKERPOP-2053] + ===== 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.