Repository: tinkerpop Updated Branches: refs/heads/tp32 7fe2ec7a4 -> e20b8ae32
Spell-check CTR Project: http://git-wip-us.apache.org/repos/asf/tinkerpop/repo Commit: http://git-wip-us.apache.org/repos/asf/tinkerpop/commit/e20b8ae3 Tree: http://git-wip-us.apache.org/repos/asf/tinkerpop/tree/e20b8ae3 Diff: http://git-wip-us.apache.org/repos/asf/tinkerpop/diff/e20b8ae3 Branch: refs/heads/tp32 Commit: e20b8ae323296517e2116b6b542d8f83052ea415 Parents: 7fe2ec7 Author: Robert Dale <robd...@gmail.com> Authored: Sun Nov 5 06:19:52 2017 -0500 Committer: Robert Dale <robd...@gmail.com> Committed: Sun Nov 5 06:21:04 2017 -0500 ---------------------------------------------------------------------- docs/src/dev/developer/contributing.asciidoc | 4 ++-- .../developer/development-environment.asciidoc | 2 +- docs/src/dev/developer/for-committers.asciidoc | 2 +- docs/src/dev/developer/release.asciidoc | 4 ++-- docs/src/dev/provider/index.asciidoc | 6 +++--- docs/src/recipes/between-vertices.asciidoc | 2 +- docs/src/recipes/centrality.asciidoc | 2 +- docs/src/recipes/connected-components.asciidoc | 2 +- docs/src/recipes/cycle-detection.asciidoc | 2 +- docs/src/recipes/duplicate-edge.asciidoc | 6 +++--- .../src/recipes/if-then-based-grouping.asciidoc | 2 +- docs/src/recipes/pagination.asciidoc | 4 ++-- docs/src/recipes/recommendation.asciidoc | 6 +++--- docs/src/recipes/tree.asciidoc | 4 ++-- .../src/reference/gremlin-applications.asciidoc | 16 ++++++++-------- docs/src/reference/gremlin-variants.asciidoc | 4 ++-- docs/src/reference/the-traversal.asciidoc | 12 ++++++------ .../the-gremlin-console/index.asciidoc | 4 ++-- .../upgrade/release-3.2.x-incubating.asciidoc | 20 ++++++++++---------- 19 files changed, 52 insertions(+), 52 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/e20b8ae3/docs/src/dev/developer/contributing.asciidoc ---------------------------------------------------------------------- diff --git a/docs/src/dev/developer/contributing.asciidoc b/docs/src/dev/developer/contributing.asciidoc index a29b7c3..29486ed 100644 --- a/docs/src/dev/developer/contributing.asciidoc +++ b/docs/src/dev/developer/contributing.asciidoc @@ -29,7 +29,7 @@ contributions to the project that help improve the TinkerPop. This section of th provide some structure for potential contributors and to give them ideas for how they could get started becoming more involved in the TinkerPop community. -NOTE: As a quick acknowledgement, this section was influenced by Apache Spark's well organized +NOTE: As a quick acknowledgment, this section was influenced by Apache Spark's well organized link:https://cwiki.apache.org/confluence/display/SPARK/Contributing+to+Spark["Contributing to Spark"] document. === Mailing List Participation @@ -189,7 +189,7 @@ link:https://github.com/apache/tinkerpop[GitHub repository] if not already done. .. It is typically best to create a branch for the changes. Consider naming that branch after the JIRA issue number to easily track what that branch is for. .. Consider which release branch (e.g. `master`, `tp31` etc) to create the development 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 other words, is the change to be targeted at a specific TinkerPop version (e.g. a patch to an older version)? When in doubt, please ask on d...@tinkerpop.apache.org. . Build the project and run tests. .. A simple build can be accomplished with maven: `mvn clean install`. http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/e20b8ae3/docs/src/dev/developer/development-environment.asciidoc ---------------------------------------------------------------------- diff --git a/docs/src/dev/developer/development-environment.asciidoc b/docs/src/dev/developer/development-environment.asciidoc index c619e19..52542f8 100644 --- a/docs/src/dev/developer/development-environment.asciidoc +++ b/docs/src/dev/developer/development-environment.asciidoc @@ -271,7 +271,7 @@ that: . `File | Settings | Compiler | Annotation Processors` has the checkbox with the "Enable annotation processing" checked. Intellij should be able to detect the processor automatically on build. -. The `gremlin-core/target` directory should not be hidden and `target/classes`, `target/gneerated-sources` and +. The `gremlin-core/target` directory should not be hidden and `target/classes`, `target/generated-sources` and `target/generated-test-sources should be marked as "Generated Sources Root". If they are not setup that way by Intellij by default then simply right-click on them use the "Mark Directory with" option to make the appropriate selections. http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/e20b8ae3/docs/src/dev/developer/for-committers.asciidoc ---------------------------------------------------------------------- diff --git a/docs/src/dev/developer/for-committers.asciidoc b/docs/src/dev/developer/for-committers.asciidoc index c62f1da..14fa90a 100644 --- a/docs/src/dev/developer/for-committers.asciidoc +++ b/docs/src/dev/developer/for-committers.asciidoc @@ -278,7 +278,7 @@ When submitting a pull request to one of the <<branches, release branches>>, be A pull request will typically be made to a target <<branches, branch>>. Assuming that branch is upstream of other release branches (e.g. a pull request made to for the branch containing 3.1.x must merge to the branch that releases -3.2.x), it is important to be sure that those changes are merged to the downstream release branches. Typicaly, +3.2.x), it is important to be sure that those changes are merged to the downstream release branches. Typically, this process is best handled by multiple pull requests: one to each release branch. As an example, consider a situation where there is a feature branch named "TINKERPOP-1234" that contains a fix for http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/e20b8ae3/docs/src/dev/developer/release.asciidoc ---------------------------------------------------------------------- diff --git a/docs/src/dev/developer/release.asciidoc b/docs/src/dev/developer/release.asciidoc index dac28b3..d3097ec 100644 --- a/docs/src/dev/developer/release.asciidoc +++ b/docs/src/dev/developer/release.asciidoc @@ -235,7 +235,7 @@ for generating javadoc and without that the binary distributions won't contain t . Copy release files from `dev/xx.yy.zz` to `release/xx.yy.zz`. . `cd release; svn add xx.yy.zz/; svn ci -m "TinkerPop xx.yy.zz release"` . Wait for Apache Sonatype to sync the artifacts to Maven Central at (link:http://repo1.maven.org/maven2/org/apache/tinkerpop/tinkerpop/[http://repo1.maven.org/maven2/org/apache/tinkerpop/tinkerpop/]). -. Report the release through link:https://reporter.apache.org/addrelease.html?tinkerpop[reporter.apache.org] (an email reminder should arrive shortly follwing the svn command above to do the release) +. Report the release through link:https://reporter.apache.org/addrelease.html?tinkerpop[reporter.apache.org] (an email reminder should arrive shortly following the svn command above to do the release) . Wait for zip distributions to to sync to the Apache mirrors (i.e ensure the download links work from a mirror). . Update home page site with references to latest distribution - specifically: .. Update the `template/header-footer.html`. @@ -243,7 +243,7 @@ for generating javadoc and without that the binary distributions won't contain t .. Update link:http://tinkerpop.apache.org/downloads.html[Downloads] page, when moving "Current Releases" to "Archived Releases" recall that the hyperlink must change to point to version in the link:https://archive.apache.org/dist/tinkerpop/[Apache Archives]. . Execute `bin/update-current-docs.sh` to migrate to the latest documentation set for `/current`. -. This step should olny occur after the website is updated and all links are working. If there are releases present in +. This step should only occur after the website is updated and all links are working. If there are releases present in SVN that represents lines of code that are no longer under development, then remove those releases. In other words, if `3.2.0` is present and `3.2.1` is released then remove `3.2.0`. However, if `3.1.3` is present and that line of code is still under potential development, it may stay. http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/e20b8ae3/docs/src/dev/provider/index.asciidoc ---------------------------------------------------------------------- diff --git a/docs/src/dev/provider/index.asciidoc b/docs/src/dev/provider/index.asciidoc index 1479320..c3105aa 100644 --- a/docs/src/dev/provider/index.asciidoc +++ b/docs/src/dev/provider/index.asciidoc @@ -525,9 +525,9 @@ except for the important one `getSideEffects()`. [source,java] public RemoteTraversalSideEffects getSideEffects(); -This method has been overriden from `Traversal` to return `RemoteTraversalSideEffects` and this interface allows a user +This method has been overridden from `Traversal` to return `RemoteTraversalSideEffects` and this interface allows a user to do a retrieval of any side-effects produced by the `Traversal`. The assumption, of course, is that the -`RemoteConnection` is communicating with a server that supports side-effect retreival (as Gremlin Server does). +`RemoteConnection` is communicating with a server that supports side-effect retrieval (as Gremlin Server does). TinkerPop provides the `DriverRemoteConnection` as a useful and link:https://github.com/apache/tinkerpop/blob/x.y.z/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/remote[example implementation]. @@ -1024,7 +1024,7 @@ and that there are only six results. request would have sent back thirty traversers. <4> Note that the sum of the bulk of each `Traverser` is thirty. -The full iteration of aa `Traversal` is thus left to the client. It must interpret the bulk on the `Traverser` and +The full iteration of a `Traversal` is thus left to the client. It must interpret the bulk on the `Traverser` and unroll it to represent the actual number of times it exists when iterated. The unrolling is typically handled directly within TinkerPop's `RemoteGraph` implementations. http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/e20b8ae3/docs/src/recipes/between-vertices.asciidoc ---------------------------------------------------------------------- diff --git a/docs/src/recipes/between-vertices.asciidoc b/docs/src/recipes/between-vertices.asciidoc index c8fa890..a947d3b 100644 --- a/docs/src/recipes/between-vertices.asciidoc +++ b/docs/src/recipes/between-vertices.asciidoc @@ -35,7 +35,7 @@ g.V(1).out().where(__.in().hasId(6)) <6> <1> There are three edges from the vertex with the identifier of "1". <2> Filter those three edges using the `where()` step using the identifier of the vertex returned by `otherV()` to ensure it matches on the vertex of concern, which is the one with an identifier of "2". -<3> Note that the same traversal will work if there are actual `Vertex` instances rather than just vertex identiers. +<3> Note that the same traversal will work if there are actual `Vertex` instances rather than just vertex identifiers. <4> The vertex with identifier "1" has all outgoing edges, so it would also be acceptable to use the directional steps of `outE()` and `inV()` since the schema allows it. <5> There is also no problem with filtering the terminating side of the traversal on multiple vertices, in this case, http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/e20b8ae3/docs/src/recipes/centrality.asciidoc ---------------------------------------------------------------------- diff --git a/docs/src/recipes/centrality.asciidoc b/docs/src/recipes/centrality.asciidoc index 30e751a..9a21636 100644 --- a/docs/src/recipes/centrality.asciidoc +++ b/docs/src/recipes/centrality.asciidoc @@ -42,7 +42,7 @@ g.V().project("v","degree").by().by(bothE().count()). <5> incoming and outgoing. <2> Calculation of in-degree centrality which only counts incoming edges to a vertex. <3> Calculation of out-degree centrality which only counts outgoing edges from a vertex. -<4> The previous examples all produce a single `Map` as their output. While that is a desireable output, producing a +<4> The previous examples all produce a single `Map` as their output. While that is a desirable output, producing a stream of `Map` objects can allow some greater flexibility. <5> For example, use of a stream enables use of an ordered limit that can be executed in a distributed fashion in OLAP traversals. http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/e20b8ae3/docs/src/recipes/connected-components.asciidoc ---------------------------------------------------------------------- diff --git a/docs/src/recipes/connected-components.asciidoc b/docs/src/recipes/connected-components.asciidoc index 7618c4d..46d61eb 100644 --- a/docs/src/recipes/connected-components.asciidoc +++ b/docs/src/recipes/connected-components.asciidoc @@ -53,7 +53,7 @@ unidirectional graphs directly so it must be simulated by ignoring the direction prior to `repeat` as this allows for return of a single length path. <2> Aggregate the `path()` of the emitted vertices to "p". It is within these paths that the list of connected components will be identified. Obviously the paths list are duplicative in the sense that they contains different -paths travelled over the same vertices. +paths traveled over the same vertices. <3> Unroll the elements in the path list with `unfold` and `dedup`. <4> Use the first vertex in each path to filter against the paths stored in "p". When a path is found that has the vertex in it, dedup the vertices in the path, order it by the identifier. Each path output from this `map` step http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/e20b8ae3/docs/src/recipes/cycle-detection.asciidoc ---------------------------------------------------------------------- diff --git a/docs/src/recipes/cycle-detection.asciidoc b/docs/src/recipes/cycle-detection.asciidoc index 741e1ec..57adc6e 100644 --- a/docs/src/recipes/cycle-detection.asciidoc +++ b/docs/src/recipes/cycle-detection.asciidoc @@ -18,7 +18,7 @@ limitations under the License. == Cycle Detection A cycle occurs in a graph where a path loops back on itself to the originating vertex. For example, in the graph -depticted below Gremlin could be use to detect the cycle among vertices `A-B-C`. +depicted below Gremlin could be use to detect the cycle among vertices `A-B-C`. image:graph-cycle.png[width=250] http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/e20b8ae3/docs/src/recipes/duplicate-edge.asciidoc ---------------------------------------------------------------------- diff --git a/docs/src/recipes/duplicate-edge.asciidoc b/docs/src/recipes/duplicate-edge.asciidoc index 6b0bc25..27eae2b 100644 --- a/docs/src/recipes/duplicate-edge.asciidoc +++ b/docs/src/recipes/duplicate-edge.asciidoc @@ -53,7 +53,7 @@ greater than one means that there is more than one edge for that edge label betw key). <3> Unroll the key-value pairs in the `Map` of paths-edges. <4> Only the values from the `Map` are needed and as mentioned earlier, those lists with more than one edge would -containa duplicate. +contain duplicate. This method find the duplicates, but does require more memory than other approaches. A slightly more complex approach that uses less memory might look like this: @@ -74,12 +74,12 @@ g.V().as("ov"). where(count(local).is(gt(1))) ---- -<1> To this point in the traversal, the outgoing edges of a vertex are being iterated with the current edge labelled +<1> To this point in the traversal, the outgoing edges of a vertex are being iterated with the current edge labeled as "e". For "e", Gremlin traverses to the incoming vertex and back on in edges of that vertex. <2> Those incoming edges are filtered with the following `where` steps. The first ensures that it does not traverse back over "e" (i.e. the current edge). The second determines if the edge label is equivalent (i.e. the test for the working definition of "duplicate"). The third determines if the outgoing vertex matches the one that started the -path labelled as "ov". +path labeled as "ov". <3> This line is quite similar to the output achieved in the previous example at step 2. A `Map` is produced that uses the outgoing vertex, the edge label, and the incoming vertex as the key, with the list of edges for that path as the value. http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/e20b8ae3/docs/src/recipes/if-then-based-grouping.asciidoc ---------------------------------------------------------------------- diff --git a/docs/src/recipes/if-then-based-grouping.asciidoc b/docs/src/recipes/if-then-based-grouping.asciidoc index 0336b13..23e24f9 100644 --- a/docs/src/recipes/if-then-based-grouping.asciidoc +++ b/docs/src/recipes/if-then-based-grouping.asciidoc @@ -55,7 +55,7 @@ if (age < 28) { } ---- -The use of `choose` is a good intutive choice for this `Traversal` as it is a natural mapping to `if-then-else`, but +The use of `choose` is a good intuitive choice for this `Traversal` as it is a natural mapping to `if-then-else`, but there is another option to consider with `coalesce`: [gremlin-groovy,modern] http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/e20b8ae3/docs/src/recipes/pagination.asciidoc ---------------------------------------------------------------------- diff --git a/docs/src/recipes/pagination.asciidoc b/docs/src/recipes/pagination.asciidoc index 13262e4..c26a1fc 100644 --- a/docs/src/recipes/pagination.asciidoc +++ b/docs/src/recipes/pagination.asciidoc @@ -17,7 +17,7 @@ limitations under the License. [[pagination]] == Pagination -image:gremlin-paging.png[float=left,width=330]In most database applications, it is oftentimes desireable to return +image:gremlin-paging.png[float=left,width=330]In most database applications, it is oftentimes desirable to return discrete blocks of data for a query rather than all of the data that the total results would contain. This approach to returning data is referred to as "pagination" and typically involves a situation where the client executing the query can specify the start position and end position (or the amount of data to return in lieu of the end position) @@ -63,7 +63,7 @@ NOTE: The first traversal above could also be written as `g.V().hasLabel('person In this case, there is no way to know the total count so the only way to know if the end of the results have been reached is to count the results from each paged result to see if there's less than the number expected or simply zero -results. In that case, further requests for additional pages would be uncessary. Of course, this approach is not +results. In that case, further requests for additional pages would be unnecessary. Of course, this approach is not free of problems either. Most graph databases will not optimize the `range()` step, meaning that the second traversal will repeat the iteration of the first two vertices to get to the second set of two vertices. In other words, for the second traversal, the graph will still read four vertices even though there was only a request for two. http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/e20b8ae3/docs/src/recipes/recommendation.asciidoc ---------------------------------------------------------------------- diff --git a/docs/src/recipes/recommendation.asciidoc b/docs/src/recipes/recommendation.asciidoc index 7d93eb9..9fefce2 100644 --- a/docs/src/recipes/recommendation.asciidoc +++ b/docs/src/recipes/recommendation.asciidoc @@ -59,7 +59,7 @@ g.addV("person").property("name","alice"). }; [] ---- -The first step to making a recommedation to "alice" using collaborative filtering is to understand what she bought: +The first step to making a recommendation to "alice" using collaborative filtering is to understand what she bought: [gremlin-groovy,existing] ---- @@ -109,7 +109,7 @@ g.V().has('name','alice').as('her'). image:recommendation-alice-3.png[width=800] This set of products could be the basis for recommendation, but it is important to remember that "alice" may have -already purchased some of these products and it would be better to not pester her with recommedations for products +already purchased some of these products and it would be better to not pester her with recommendations for products that she already owns. Those products she already purchased can be excluded as follows: [gremlin-groovy,existing] @@ -247,7 +247,7 @@ g.V().has("person","name","alice").as("alice"). ---- In considering the practical applications of this recipe, it is worth revisiting the earlier "basic" version of the -reccomendation algorithm: +recommendation algorithm: [gremlin-groovy,existing] ---- http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/e20b8ae3/docs/src/recipes/tree.asciidoc ---------------------------------------------------------------------- diff --git a/docs/src/recipes/tree.asciidoc b/docs/src/recipes/tree.asciidoc index b11e842..f87784f 100644 --- a/docs/src/recipes/tree.asciidoc +++ b/docs/src/recipes/tree.asciidoc @@ -168,13 +168,13 @@ g.withSack(1).V().has('name','C'). === Time-based Indexing -Trees can be used for modelling time-oriented data in a graph. Modeling time where there are "year", "month" and "day" +Trees can be used for modeling time-oriented data in a graph. Modeling time where there are "year", "month" and "day" vertices (or lower granularity as needed) allows the structure of the graph to inherently index data tied to them. image:gremlin-index-time.png[width=800] NOTE: This model is discussed further in this Neo4j link:https://neo4j.com/blog/modeling-a-multilevel-index-in-neoj4/[blog post]. -Also, there can be other versions of this model that utilize different edge/vertex labelling and property naming +Also, there can be other versions of this model that utilize different edge/vertex labeling and property naming strategies. The schema depicted here is designed for simplicity. The Gremlin script below creates the graph depicted in the graph above: http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/e20b8ae3/docs/src/reference/gremlin-applications.asciidoc ---------------------------------------------------------------------- diff --git a/docs/src/reference/gremlin-applications.asciidoc b/docs/src/reference/gremlin-applications.asciidoc index c2965ce..6135af9 100644 --- a/docs/src/reference/gremlin-applications.asciidoc +++ b/docs/src/reference/gremlin-applications.asciidoc @@ -300,7 +300,7 @@ v[2] It is also possible to pass multiple scripts by specifying multiple `-e` options. The scripts will execute in the order that they are specified. Note that only the arguments from the last script executed will be preserved in the console. Finally, if the arguments conflict with the reserved flags that `gremlin.sh` responds double quotes can be used to -wrap all the arugments to the option: +wrap all the arguments to the option: [source,bash] ---- @@ -351,7 +351,7 @@ Note that the user can now reference `g` (and `graph` for that matter) at startu variable initialization code into the console. Like, execution mode, it is also possible to pass multiple scripts by specifying multiple `-i` options. See the -<<execution-mode, Execution Mode Section>> for more information on the specfics of that capability. +<<execution-mode, Execution Mode Section>> for more information on the specifics of that capability. [[gremlin-server]] == Gremlin Server @@ -621,7 +621,7 @@ x + y ---- In the above example, the `:remote console` command is executed. It places the console in a state where the `:>` is -no longer required. Each script line is actually automatically submitted to Gremlin Server for evalaution. The +no longer required. Each script line is actually automatically submitted to Gremlin Server for evaluation. The variables `x` and `y` that were defined actually don't exist locally - they only exist on the server! In this sense, putting the console in this mode is basically like creating a window to a session on Gremlin Server. @@ -1069,7 +1069,7 @@ The following table describes the various configuration options that Gremlin Ser |authentication.authenticationHandler | The fully qualified classname of an `AbstractAuthenticationHandler` implementation to use. If this setting is not present, but the `authentication.authenticator` is, it will use that authenticator with the default `AbstractAuthenticationHandler` implementation for the specified `Channelizer` |_none_ |authentication.config |A `Map` of configuration settings to be passes to the `Authenticator` when it is constructed. The settings available are dependent on the implementation. |_none_ |channelizer |The fully qualified classname of the `Channelizer` implementation to use. A `Channelizer` is a "channel initializer" which Gremlin Server uses to define the type of processing pipeline to use. By allowing different `Channelizer` implementations, Gremlin Server can support different communication protocols (e.g. WebSocket, Java NIO, etc.). |`WebSocketChannelizer` -|graphManager |The fully qualified classname of the `GraphManager` implementation to use. A `GraphManager` is a class that adheres to the TinkerPop `GraphManager` interface, allowing custom implementations for storing and managing graph references, as well as defining custom methods to open and close graphs instantiations. It is important to note that the Tinkerpop Http and WebSocketChannelizers auto-commit and auto-rollback based on the graphs stored in the graphManager upon script execution completion. |`DefaultGraphManager` +|graphManager |The fully qualified classname of the `GraphManager` implementation to use. A `GraphManager` is a class that adheres to the TinkerPop `GraphManager` interface, allowing custom implementations for storing and managing graph references, as well as defining custom methods to open and close graphs instantiations. It is important to note that the TinkerPop HTTP and WebSocketChannelizers auto-commit and auto-rollback based on the graphs stored in the graphManager upon script execution completion. |`DefaultGraphManager` |graphs |A `Map` of `Graph` configuration files where the key of the `Map` becomes the name to which the `Graph` will be bound and the value is the file name of a `Graph` configuration file. |_none_ |gremlinPool |The number of "Gremlin" threads available to execute actual scripts in a `ScriptEngine`. This pool represents the workers available to handle blocking operations in Gremlin Server. When set to `0`, Gremlin Server will use the value provided by `Runtime.availableProcessors()`. |0 |host |The name of the host to bind the server to. |localhost @@ -1576,7 +1576,7 @@ Regardless of the output, the metrics gathered are the same. Each metric is pref * `op.eval` - the number of script evaluations, mean rate, 1, 5, and 15 minute rates, minimum, maximum, median, mean, and standard deviation evaluation times, as well as the 75th, 95th, 98th, 99th and 99.9th percentile evaluation times (note that these time apply to both sessionless and in-session requests). -* `op.traversal` - the number of `Traveral` executions, mean rate, 1, 5, and 15 minute rates, minimum, maximum, median, +* `op.traversal` - the number of `Traversal` executions, mean rate, 1, 5, and 15 minute rates, minimum, maximum, median, mean, and standard deviation evaluation times, as well as the 75th, 95th, 98th, 99th and 99.9th percentile evaluation times. * `engine-name.session.session-id.*` - metrics related to different `GremlinScriptEngine` instances configured for @@ -1727,7 +1727,7 @@ in a transaction. With this configuration of `client` there is no need to close When using this mode of the `SessionedClient` it is important to recognize that global variable state for the session is not rolled-back on failure depending on where the failure occurs. For example, sending the following script would -create a variable "x" in global session scope that would be acccessible on the next request: +create a variable "x" in global session scope that would be accessible on the next request: [source,groovy] x = 1 @@ -1746,7 +1746,7 @@ example, this script: a = 1 g.addV() -would sucessfully evaluate and return a `Traversal`. The variable "a" would be available on the next request. However, +would successfully evaluate and return a `Traversal`. The variable "a" would be available on the next request. However, if there was a failure in transaction management on the call to `commit()`, "a" would still be available to the next request. @@ -1786,7 +1786,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 <<sessions,consider sessions>>. +If having this behavior is desirable, 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/e20b8ae3/docs/src/reference/gremlin-variants.asciidoc ---------------------------------------------------------------------- diff --git a/docs/src/reference/gremlin-variants.asciidoc b/docs/src/reference/gremlin-variants.asciidoc index b8a3622..c9ba893 100644 --- a/docs/src/reference/gremlin-variants.asciidoc +++ b/docs/src/reference/gremlin-variants.asciidoc @@ -220,7 +220,7 @@ These can be used analogously to how they are used in Gremlin-Java. g.V().hasLabel('person').has('age',P.gt(30)).order().by('age',Order.decr).toList() ---- -Moreover, by importing the `statics` of Gremlin-Python, the class prefixes can be ommitted. +Moreover, by importing the `statics` of Gremlin-Python, the class prefixes can be omitted. [source,python] >>> statics.load_statics(globals()) @@ -372,7 +372,7 @@ These can be used analogously to how they are used in Gremlin-Java. [source,csharp] g.V().HasLabel("person").Has("age",P.Gt(30)).Order().By("age",Order.decr).ToList() -Moreover, the class prefixes can be ommitted with a `using static`. +Moreover, the class prefixes can be omitted with a `using static`. [source,csharp] ---- http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/e20b8ae3/docs/src/reference/the-traversal.asciidoc ---------------------------------------------------------------------- diff --git a/docs/src/reference/the-traversal.asciidoc b/docs/src/reference/the-traversal.asciidoc index 16c0e78..68773f5 100644 --- a/docs/src/reference/the-traversal.asciidoc +++ b/docs/src/reference/the-traversal.asciidoc @@ -108,7 +108,7 @@ g.V().hasLabel('person') <3> ---- <1> A filter that only allows the vertex to pass if it has the "person" label -<2> The same operation, but using the traversal represention of `filter()`. +<2> The same operation, but using the traversal representation of `filter()`. <3> The more specific `has()`-step is implemented as a `filter()` with respective predicate. image:side-effect-lambda.png[width=175,float=right] @@ -137,7 +137,7 @@ g.V().choose(has('name','marko'), ---- <1> If the vertex is "marko", get his age, else get the name of the vertex. -<2> The same operation, but using the traversal represention of `branch()`. +<2> The same operation, but using the traversal representing of `branch()`. <3> The more specific boolean-based `choose()`-step is implemented as a `branch()`. [[terminal-steps]] @@ -442,7 +442,7 @@ g.V().groupCount('a').by(label).cap('a') <1> g.V().groupCount('a').by(label).groupCount('b').by(outE().count()).cap('a','b') <2> ---- -<1> Group and count verticies by their label. Emit the side effect labeled 'a', which is the group count by label. +<1> Group and count vertices by their label. Emit the side effect labeled 'a', which is the group count by label. <2> Same as statement 1, but also emit the side effect labeled 'b' which groups vertices by the number of out edges. [[choose-step]] @@ -813,7 +813,7 @@ g.V().hasNot('age').values('name') <7> <1> Find all vertices whose ages are between 20 (inclusive) and 30 (exclusive). <2> Find all vertices whose ages are not between 20 (inclusive) and 30 (exclusive). <3> Find all vertices whose names are exact matches to any names in the collection `[josh,marko]`, display all -the key,value pairs for those verticies. +the key,value pairs for those vertices. <4> Find all vertices whose names are not in the collection `[josh,marko]`, display all the key,value pairs for those vertices. <5> Same as the prior example save using `not` on `within` to yield `without`. <6> Find all age-properties and emit their value. @@ -2391,7 +2391,7 @@ g.V(4).inE().bothV() === Where Step The `where()`-step filters the current object based on either the object itself (`Scope.local`) or the path history -of the object (`Scope.global`) (*filter*). This step is typically used in conjuction with either +of the object (`Scope.global`) (*filter*). This step is typically used in conjunction with either <<match-step,`match()`>>-step or <<select-step,`select()`>>-step, but can be used in isolation. [gremlin-groovy,modern] @@ -2797,7 +2797,7 @@ g.V('42a') ---- Other `Graph` implementations, such as Neo4j, generate element identifiers automatically and cannot be assigned. -As a helper, `ElementIdStrategy` can be used to make identifier assignment possible by using vertex and edge indicies +As a helper, `ElementIdStrategy` can be used to make identifier assignment possible by using vertex and edge indices under the hood. [gremlin-groovy] http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/e20b8ae3/docs/src/tutorials/the-gremlin-console/index.asciidoc ---------------------------------------------------------------------- diff --git a/docs/src/tutorials/the-gremlin-console/index.asciidoc b/docs/src/tutorials/the-gremlin-console/index.asciidoc index 506d882..da8bac3 100644 --- a/docs/src/tutorials/the-gremlin-console/index.asciidoc +++ b/docs/src/tutorials/the-gremlin-console/index.asciidoc @@ -23,7 +23,7 @@ image::apache-tinkerpop-logo.png[width=500,link="http://tinkerpop.apache.org";] In link:http://tinkerpop.apache.org/docs/x.y.z/tutorials/getting-started/#_the_first_five_minutes["The First Five Minutes"] of the link:http://tinkerpop.apache.org[Apache TinkerPop] tutorial on how to -link:http://tinkerpop.apache.org/docs/x.y.z/tutorials/getting-started/[get started] wth TinkerPop and graphs, the +link:http://tinkerpop.apache.org/docs/x.y.z/tutorials/getting-started/[get started] with TinkerPop and graphs, the importance of the link:http://tinkerpop.apache.org/docs/x.y.z/reference/#gremlin-console[Gremlin Console] was introduced. This tutorial further explores the usage of the console in the daily work of Gremlin developers delving more deeply into the details of its operations and expanding upon the basic usage guide in the @@ -621,7 +621,7 @@ Iteration is performed by the call to `forEachRemaining()`. The closure supplied in the `Traversal`. Note the use of `def` in that closure to declare the "statement" variable. In the console, the use of `def` inside a closure scopes that variable to the closure. Without `def` the "row" variable would be accessible globally (i.e. at the `gremlin>` prompt). The use of `def` at the console prompt for variable definition -is unecessary and will result in error: +is unnecessary and will result in error: [source,groovy] ---- http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/e20b8ae3/docs/src/upgrade/release-3.2.x-incubating.asciidoc ---------------------------------------------------------------------- diff --git a/docs/src/upgrade/release-3.2.x-incubating.asciidoc b/docs/src/upgrade/release-3.2.x-incubating.asciidoc index 60fd320..c09f9c6 100644 --- a/docs/src/upgrade/release-3.2.x-incubating.asciidoc +++ b/docs/src/upgrade/release-3.2.x-incubating.asciidoc @@ -196,7 +196,7 @@ See: link:https://issues.apache.org/jira/browse/TINKERPOP-1694[TINKERPOP-1694] ==== WsAndHttpChannelizer -The `WsAndHttpChannelizer` has been added to allow for processing both WebSocket and Http requests on the same +The `WsAndHttpChannelizer` has been added to allow for processing both WebSocket and HTTP requests on the same port and gremlin server. The `SaslAndHttpBasicAuthenticationHandler` has also been added to service authentication for both protocols in conjunction with the `SimpleAuthenticator`. @@ -235,7 +235,7 @@ See: link:https://issues.apache.org/jira/browse/TINKERPOP-1676[TINKERPOP-1676] ==== DSL Support It has always been possible to construct Domain Specific Languages (DSLs) with Gremlin, but the approach has required -a somewhat deep understanding of the TinkerPop code base and it is not something that has had a recommeded method +a somewhat deep understanding of the TinkerPop code base and it is not something that has had a recommended method for implementation. With this release, TinkerPop simplifies DSL development and provides the best practices for their implementation. @@ -329,7 +329,7 @@ See: link:https://issues.apache.org/jira/browse/TINKERPOP-1044[TINKERPOP-1044] The `gremlin.sh` command has two flags, `-i` and `-e`, which are used to pass a script and arguments into the Gremlin Console for execution. Those flags now allow for passing multiple scripts and related arguments to be supplied which -can yield greater flexibilty in automation tasks. +can yield greater flexibility in automation tasks. [source,bash] ---- @@ -351,13 +351,13 @@ See: link:https://issues.apache.org/jira/browse/TINKERPOP-1387[TINKERPOP-1387] Gremlin Server previously implemented its own final `GraphManager` class. Now, the `GraphManager` has been changed to an interface, and users can supply their own `GraphManager` implementations in their YAML. The previous `GraphManager` class was meant be used by classes internal to Gremlin Server, but it was public so if it was used for some reason by -usrs then then a compile error can be expected. To correct this problem, which will likely manifest as a compile error +users then then a compile error can be expected. To correct this problem, which will likely manifest as a compile error when trying to create a `new GraphManager()` instance, simply change the code to `new DefaultGraphManager(Settings)`. In addition to the change mentioned above, several methods on `GraphManager` were deprecated: * `getGraphs()` should be replaced by the combination of `getGraphNames()` and then `getGraph(String)` -* `getTraversalSources()` is similarly replaced and should instead use a combinatio of `getTraversalSourceNames()` and +* `getTraversalSources()` is similarly replaced and should instead use a combination of `getTraversalSourceNames()` and `getTraversalSource(String)` See: link:https://issues.apache.org/jira/browse/TINKERPOP-1438[TINKERPOP-1438] @@ -365,7 +365,7 @@ See: link:https://issues.apache.org/jira/browse/TINKERPOP-1438[TINKERPOP-1438] ==== Gremlin-Python Driver Gremlin-Python now offers a more complete driver implementation that uses connection pooling and the Python `concurrent.futures` module to provide asynchronous I/0 using threading. The default underlying -websocket client implementation is still provided by Tornado, but it is trivial to plug in another client by +WebSocket client implementation is still provided by Tornado, but it is trivial to plug in another client by defining the `Transport` interface. Using the `DriverRemoteConnection` class is the exact same as in previous versions; however, @@ -404,7 +404,7 @@ Furthermore, `PathFilterStep` also support `from()`-, `to()`-, and `by()`-modula `LazyBarrierStrategy` was trying to do to much by considering `Traverser` effects on network I/O by appending an `NoOpBarrierStrategy` to the end of the root traversal. This should not be accomplished by `LazyBarrierStrategy`, -but instead by `RemoteStrategy`. `RemoteStrategy` now tries to barrier-append. This may effect the reasoninig logic in +but instead by `RemoteStrategy`. `RemoteStrategy` now tries to barrier-append. This may effect the reasoning logic in some `ProviderStrategies`. Most likely not, but just be aware. See: link:https://issues.apache.org/jira/browse/TINKERPOP-1627[TINKERPOP-1627] @@ -626,7 +626,7 @@ a long run job (e.g. an OLAP-based traversal) executing, as that job will block By exercising the option to a do a "forced close" the session will skip trying to close the transactions and just attempt to interrupt the long run job. By not closing transactions, the session leaves it up to the underlying graph database to sort out how it will deal with those orphaned transactions. On the positive side though (for those graphs -which do that well) , long run jobs have the opporunity to be cancelled without waiting for a timeout of the job itself +which do that well) , long run jobs have the opportunity to be cancelled without waiting for a timeout of the job itself which will allow resources to be released earlier. The "force" argument is passed on the "close" message and is a boolean value. This is an optional argument to "close" @@ -718,7 +718,7 @@ See: link:https://issues.apache.org/jira/browse/TINKERPOP-1330[TINKERPOP-1330] ==== Change In has() Method Signatures -The TinkerPop 3.2.2 release unintentionally intoduced a breaking change for some `has()` method overloads. In particular the +The TinkerPop 3.2.2 release unintentionally introduced a breaking change for some `has()` method overloads. In particular the behavior for single item array arguments was changed: [source,text] @@ -878,7 +878,7 @@ See: link:https://issues.apache.org/jira/browse/TINKERPOP-1455[TINKERPOP-1455] Both `Graph.Exceptions.elementNotFound()` methods have been deprecated. These exceptions were being asserted in the test suite but were not being used anywhere in `gremlin-core` itself. The assertions have been modified to simply -assert that `NoSuchElementException` was thrown, which is precisely the behavior that was being indirected asserted +assert that `NoSuchElementException` was thrown, which is precisely the behavior that was being indirectly asserted when `Graph.Exceptions.elementNotFound()` were being used. Providers should not need to take any action in this case for their tests to pass, however, it would be wise to remove
