Repository: tinkerpop Updated Branches: refs/heads/master 0f5f2d81e -> 857761693
minor word and link cleanup Project: http://git-wip-us.apache.org/repos/asf/tinkerpop/repo Commit: http://git-wip-us.apache.org/repos/asf/tinkerpop/commit/a707a8db Tree: http://git-wip-us.apache.org/repos/asf/tinkerpop/tree/a707a8db Diff: http://git-wip-us.apache.org/repos/asf/tinkerpop/diff/a707a8db Branch: refs/heads/master Commit: a707a8db6088ba3df86fa056606b7365f0a3d2da Parents: 168097b Author: Robert Dale <[email protected]> Authored: Sat Jul 16 19:41:52 2016 -0400 Committer: Robert Dale <[email protected]> Committed: Wed Jul 27 14:20:19 2016 -0400 ---------------------------------------------------------------------- docs/src/dev/developer/contributing.asciidoc | 6 ++-- docs/src/dev/provider/index.asciidoc | 4 +-- .../src/reference/gremlin-applications.asciidoc | 4 +-- .../reference/implementations-neo4j.asciidoc | 12 ++++---- docs/src/reference/preface.asciidoc | 4 +-- docs/src/reference/the-graphcomputer.asciidoc | 2 +- docs/src/reference/the-traversal.asciidoc | 30 ++++++++++++++++++-- .../upgrade/release-3.1.x-incubating.asciidoc | 4 +-- 8 files changed, 46 insertions(+), 20 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/a707a8db/docs/src/dev/developer/contributing.asciidoc ---------------------------------------------------------------------- diff --git a/docs/src/dev/developer/contributing.asciidoc b/docs/src/dev/developer/contributing.asciidoc index bcc2e04..456a055 100644 --- a/docs/src/dev/developer/contributing.asciidoc +++ b/docs/src/dev/developer/contributing.asciidoc @@ -62,7 +62,7 @@ Reviewing Changes Virtually all changes to TinkerPop's source code are performed via GitHub link:https://github.com/apache/tinkerpop/pulls[pull requests]. When a pull request is issue it undergoes a <<rtc,review process>> prior to be merged to a release branch. Anyone is free to comment and provide a vote (+1/+0/-1) -on a pull request. Note that votes of non-commiters are considered non-binding, but are certainly considered in the +on a pull request. Note that votes of non-committers are considered non-binding, but are certainly considered in the review process. Writing Documentation @@ -182,7 +182,7 @@ to easily track what that branch is for. .. Consider which branch to create the branch from in the first place. In other words, is the change to be targetted at a specific TinkerPop version (e.g. a patch to an older version)? When in doubt, please ask on [email protected]. -. Bulid the project and run tests. +. Build the project and run tests. .. A simple build can be accomplished with maven: `mvn clean install`. .. Often, a "simple build" isn't sufficient and integration tests are required: `mvn clean install -DskipIntegrationTests=false -DincludeNeo4j`. Note that Hadoop must be running for the integration @@ -221,4 +221,4 @@ and resolving the conflicts by hand, then pushing the result to your branch. Or and force pushing the branch. . Try to be responsive to the discussion rather than let days pass between replies -On successful review, the *pull request will be merged* to the main repository and the JIRA issue will be closed. \ No newline at end of file +On successful review, the *pull request will be merged* to the main repository and the JIRA issue will be closed. http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/a707a8db/docs/src/dev/provider/index.asciidoc ---------------------------------------------------------------------- diff --git a/docs/src/dev/provider/index.asciidoc b/docs/src/dev/provider/index.asciidoc index 7b876a1..9a07245 100644 --- a/docs/src/dev/provider/index.asciidoc +++ b/docs/src/dev/provider/index.asciidoc @@ -147,7 +147,7 @@ Implementing MapReduce Emitters +++++++++++++++++++++++++++++++ image:hadoop-logo-notext.png[width=150,float=left] The MapReduce framework in TinkerPop3 is similar to the model -popularized by link:http://apache.hadoop.org[Hadoop]. The primary difference is that all Mappers process the vertices +popularized by link:http://hadoop.apache.org[Hadoop]. The primary difference is that all Mappers process the vertices of the graph, not an arbitrary key/value pair. However, the vertices' edges can not be accessed -- only their properties. This greatly reduces the amount of data needed to be pushed through the MapReduce engine as any edge information required, can be computed in the VertexProgram.execute() method. Moreover, at this stage, vertices can @@ -964,4 +964,4 @@ Console plugin host. Simply instantiate and return a `RemoteAcceptor` in the `G of the plugin implementation. Generally speaking, each call to `remoteAcceptor()` should produce a new instance of a `RemoteAcceptor`. It will likely be necessary that you provide context from the `GremlinPlugin` to the `RemoteAcceptor` plugin. For example, the `RemoteAcceptor` implementation might require an instance of `Groovysh` -to provide a way to dynamically evaluate a script provided to it so that it can process the results in a different way. \ No newline at end of file +to provide a way to dynamically evaluate a script provided to it so that it can process the results in a different way. http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/a707a8db/docs/src/reference/gremlin-applications.asciidoc ---------------------------------------------------------------------- diff --git a/docs/src/reference/gremlin-applications.asciidoc b/docs/src/reference/gremlin-applications.asciidoc index 488663f..9f5121f 100644 --- a/docs/src/reference/gremlin-applications.asciidoc +++ b/docs/src/reference/gremlin-applications.asciidoc @@ -697,7 +697,7 @@ WebSockets-based connection, it can also be configured to support link:http://en The REST endpoint provides for a communication protocol familiar to most developers, with a wide support of programming languages, tools and libraries for accessing it. As a result, REST provides a fast way to get started with Gremlin Server. It also may represent an easier upgrade path from link:http://rexster.tinkerpop.com/[Rexster] -as the API for the endpoint is very similar to Rexster's link:https://github.org/apache/tinkerpop/rexster/wiki/Gremlin-Extension[Gremlin Extension]. +as the API for the endpoint is very similar to Rexster's link:https://github.com/tinkerpop/rexster/wiki/Gremlin-Extension[Gremlin Extension]. Gremlin Server provides for a single REST endpoint - a Gremlin evaluator - which allows the submission of a Gremlin script as a request. For each request, it returns a response containing the serialized results of that script. @@ -1446,7 +1446,7 @@ Display stack trace? [yN] n ---- The same behavior would be seen with REST or when using sessionless requests through one of the Gremlin Server drivers. -If having this behavior is desireable, then <<considering-sessions,consider sessions>>. +If having this behavior is desireable, then <<sessions,consider sessions>>. There is an exception to this notion of state not existing between requests and that is globally defined functions. All functions created via scripts are global to the server. http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/a707a8db/docs/src/reference/implementations-neo4j.asciidoc ---------------------------------------------------------------------- diff --git a/docs/src/reference/implementations-neo4j.asciidoc b/docs/src/reference/implementations-neo4j.asciidoc index d1fc30b..8c63925 100644 --- a/docs/src/reference/implementations-neo4j.asciidoc +++ b/docs/src/reference/implementations-neo4j.asciidoc @@ -33,7 +33,7 @@ Neo4j-Gremlin </dependency> ---- -link:http://neotechnology.com[Neo Technology] are the developers of the OLTP-based link:http://neo4j.org[Neo4j graph database]. +link:http://neo4j.com[Neo Technology] are the developers of the OLTP-based link:http://neo4j.com[Neo4j graph database]. WARNING: Unless under a commercial agreement with Neo Technology, Neo4j is licensed link:http://en.wikipedia.org/wiki/Affero_General_Public_License[AGPL]. The `neo4j-gremlin` module is licensed Apache2 @@ -69,8 +69,8 @@ NOTE: `Neo4jGraphStep` will attempt to discern which indices to use when executi The Gremlin-Console session below demonstrates Neo4j indices. For more information, please refer to the Neo4j documentation: -* Manipulating indices with link:http://docs.neo4j.org/chunked/stable/query-schema-index.html[Cypher]. -* Manipulating indices with the Neo4j link:http://docs.neo4j.org/chunked/stable/tutorials-java-embedded-new-index.html[Java API]. +* Manipulating indices with link:http://neo4j.com/docs/developer-manual/current/#query-schema-index[Cypher]. +* Manipulating indices with the Neo4j link:http://neo4j.com/docs/stable/tutorials-java-embedded-new-index.html[Java API]. [gremlin-groovy] ---- @@ -116,7 +116,7 @@ graph.close() Multi/Meta-Properties ~~~~~~~~~~~~~~~~~~~~~ -`Neo4jGraph` supports both multi- and meta-properties (see <<_vertex_properties,vertex properties>>). These features +`Neo4jGraph` supports both multi- and meta-properties (see <<vertex-properties,vertex properties>>). These features are not native to Neo4j and are implemented using "hidden" Neo4j nodes. For example, when a vertex has multiple "name" properties, each property is a new node (multi-properties) which can have properties attached to it (meta-properties). As such, the native, underlying representation may become difficult to query directly using @@ -156,7 +156,7 @@ Cypher image::gremlin-loves-cypher.png[width=400] -NeoTechnology are the creators of the graph pattern-match query language link:http://www.neo4j.org/learn/cypher[Cypher]. +NeoTechnology are the creators of the graph pattern-match query language link:https://neo4j.com/developer/cypher-query-language/[Cypher]. It is possible to leverage Cypher from within Gremlin by using the `Neo4jGraph.cypher()` graph traversal method. [gremlin-groovy] @@ -179,7 +179,7 @@ Multi-Label TinkerPop3 requires every `Element` to have a single, immutable string label (i.e. a `Vertex`, `Edge`, and `VertexProperty`). In Neo4j, a `Node` (vertex) can have an -link:http://neo4j.com/docs/stable/graphdb-neo4j-labels.html[arbitrary number of labels] while a `Relationship` +link:http://neo4j.com/docs/developer-manual/current/#graphdb-neo4j-labels[arbitrary number of labels] while a `Relationship` (edge) can have one and only one. Furthermore, in Neo4j, `Node` labels are mutable while `Relationship` labels are not. In order to handle this mismatch, three `Neo4jVertex` specific methods exist in Neo4j-Gremlin. http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/a707a8db/docs/src/reference/preface.asciidoc ---------------------------------------------------------------------- diff --git a/docs/src/reference/preface.asciidoc b/docs/src/reference/preface.asciidoc index 142f935..6ee6e8b 100644 --- a/docs/src/reference/preface.asciidoc +++ b/docs/src/reference/preface.asciidoc @@ -56,7 +56,7 @@ Gremlin responded: The machines wondered: - "If what is is the TinkerPop, then perhaps we are The TinkerPop and our realization is simply the realization of + "If what this is is the TinkerPop, then perhaps we are The TinkerPop and our realization is simply the realization of the TinkerPop?" Would the machines, by their very nature of realizing The TinkerPop, be The TinkerPop? Or, on the same side of the @@ -94,4 +94,4 @@ image::gremlintron.png[width=400] NOTE: TinkerPop2 and below made a sharp distinction between the various TinkerPop projects: Blueprints, Pipes, Gremlin, Frames, Furnace, and Rexster. With TinkerPop3, all of these projects have been merged and are generally known as Gremlin. *Blueprints* -> Gremlin Structure API : *Pipes* -> `GraphTraversal` : *Frames* -> `Traversal` : -*Furnace* -> `GraphComputer` and `VertexProgram` : *Rexster* -> GremlinServer. \ No newline at end of file +*Furnace* -> `GraphComputer` and `VertexProgram` : *Rexster* -> GremlinServer. http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/a707a8db/docs/src/reference/the-graphcomputer.asciidoc ---------------------------------------------------------------------- diff --git a/docs/src/reference/the-graphcomputer.asciidoc b/docs/src/reference/the-graphcomputer.asciidoc index f9116fb..453b62e 100644 --- a/docs/src/reference/the-graphcomputer.asciidoc +++ b/docs/src/reference/the-graphcomputer.asciidoc @@ -74,7 +74,7 @@ image::graphcomputer.png[width=500] The example below demonstrates how to submit a VertexProgram to a graph's GraphComputer. `GraphComputer.submit()` yields a `Future<ComputerResult>`. The `ComputerResult` has the resultant computed graph which can be a full copy of the original graph (see <<hadoop-gremlin,Hadoop-Gremlin>>) or a view over the original graph (see -<<tinkergraph,TinkerGraph>>). The ComputerResult also provides access to computational side-effects called `Memory` +<<tinkergraph-gremlin,TinkerGraph>>). The ComputerResult also provides access to computational side-effects called `Memory` (which includes, for example, runtime, number of iterations, results of MapReduce jobs, and VertexProgram-specific memory manipulations). http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/a707a8db/docs/src/reference/the-traversal.asciidoc ---------------------------------------------------------------------- diff --git a/docs/src/reference/the-traversal.asciidoc b/docs/src/reference/the-traversal.asciidoc index ca4c6be..e897810 100644 --- a/docs/src/reference/the-traversal.asciidoc +++ b/docs/src/reference/the-traversal.asciidoc @@ -205,7 +205,7 @@ g.V(1).property('friendWeight',outE('knows').values('weight').sum(),'acl','priva g.V(1).properties('friendWeight').valueMap() <3> ---- -<1> For vertices, a cardinality can be provided for <<vertex properties,vertex-properties>>. +<1> For vertices, a cardinality can be provided for <<vertex-properties,vertex properties>>. <2> It is possible to select the property value (as well as key) via a traversal. <3> For vertices, the `property()`-step can add meta-properties. @@ -376,7 +376,7 @@ 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*). -[cap-step]] +[[cap-step]] Cap Step ~~~~~~~~ @@ -1127,6 +1127,12 @@ g.V().repeat(both()).times(3).values('age').min() IMPORTANT: `min(local)` determines the min of the current, local object (not the objects in the traversal stream). This works for `Collection` and `Number`-type objects. For any other object, a min of `Double.NaN` is returned. +[[option-step]] +Option Step +~~~~~~~~~~~~~ + +An option to a <<branch-step,`branch()`>> or <<choose-step,`choose()`>> + [[or-step]] Or Step ~~~~~~~ @@ -1286,6 +1292,26 @@ path.c path.d == path.e ---- +<<<<<<< HEAD +======= +[[peerpressure-step]] +PeerPressure Step +~~~~~~~~~~~~~~~~~ + +The `peerPressure()`-step (*map*/*sideEffect*) clusters vertices using <<peerpressurevertexprogram,`PeerPressureVertexProgram`>>. + +IMPORTANT: The `peerPressure()`-step is a `VertexComputing`-step and as such, can only be used against a graph that supports `GraphComputer` (OLAP). + +[gremlin-groovy,modern] +---- +g = graph.traversal().withComputer() +g.V().peerPressure().by('cluster').values('cluster') +g.V().hasLabel('person'). + peerPressure().by('cluster'). + group().by('cluster').by('name') +---- + +>>>>>>> deb99f6... minor word and link cleanup [[profile-step]] Profile Step ~~~~~~~~~~~~ http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/a707a8db/docs/src/upgrade/release-3.1.x-incubating.asciidoc ---------------------------------------------------------------------- diff --git a/docs/src/upgrade/release-3.1.x-incubating.asciidoc b/docs/src/upgrade/release-3.1.x-incubating.asciidoc index 1ed3ed4..11cdb32 100644 --- a/docs/src/upgrade/release-3.1.x-incubating.asciidoc +++ b/docs/src/upgrade/release-3.1.x-incubating.asciidoc @@ -324,7 +324,7 @@ backward compatible with previous versions) will become the future standard mode it provides a more efficient method for transaction management. See: link:https://issues.apache.org/jira/browse/TINKERPOP-930[TINKERPOP-930], -link:http://tinkerpop.apache.org/docs/3.1.1-incubating/#considering-transactions[Reference Documentation - Considering Transactions] +link:http://tinkerpop.apache.org/docs/3.1.1-incubating/reference/#considering-transactions[Reference Documentation - Considering Transactions] Deprecated credentialsDbLocation ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -343,7 +343,7 @@ the `gremlin.tinkergraph.graphLocation` as soon as possible, as the deprecated s release. See: link:https://issues.apache.org/jira/browse/TINKERPOP-981[TINKERPOP-981], -link:http://tinkerpop.apache.org/docs/3.1.1-incubating/#_security[Reference Documentation - Gremlin Server Security] +link:http://tinkerpop.apache.org/docs/3.1.1-incubating/reference/#_security[Reference Documentation - Gremlin Server Security] TinkerGraph Supports Any I/O ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
