You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tinkerpop.apache.org by sp...@apache.org on 2015/09/09 14:57:28 UTC

incubator-tinkerpop git commit: Update docs around PartitionStrategy to reflect support of VertexProperty.

Repository: incubator-tinkerpop
Updated Branches:
  refs/heads/master 9aad7b26c -> 2737a69cb


Update docs around PartitionStrategy to reflect support of VertexProperty.


Project: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/commit/2737a69c
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/tree/2737a69c
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/diff/2737a69c

Branch: refs/heads/master
Commit: 2737a69cb9ee3e55a048d25935e4464a18b669ac
Parents: 9aad7b2
Author: Stephen Mallette <sp...@genoprime.com>
Authored: Wed Sep 9 08:57:03 2015 -0400
Committer: Stephen Mallette <sp...@genoprime.com>
Committed: Wed Sep 9 08:57:03 2015 -0400

----------------------------------------------------------------------
 docs/src/the-traversal.asciidoc | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/2737a69c/docs/src/the-traversal.asciidoc
----------------------------------------------------------------------
diff --git a/docs/src/the-traversal.asciidoc b/docs/src/the-traversal.asciidoc
index 2041522..e9e4634 100644
--- a/docs/src/the-traversal.asciidoc
+++ b/docs/src/the-traversal.asciidoc
@@ -1942,7 +1942,7 @@ image::partition-graph.png[width=325]
 
 `PartitionStrategy` partitions the vertices and edges of a graph into `String` named partitions (i.e. buckets, subgraphs, etc.). The idea behind `PartitionStrategy` is presented in the image above where each element is in a single partition (represented by its color). Partitions can be read from, written to, and linked/joined by edges that span one or two partitions (e.g. a tail vertex in one partition and a head vertex in another).
 
-There are three primary variables in `PartitionStrategy`:
+There are three primary configurations in `PartitionStrategy`:
 
 . Partition Key - The property key that denotes a String value representing a partition.
 . Write Partition - A `String` denoting what partition all future written elements will be in.
@@ -1963,6 +1963,8 @@ gA.V()
 gB.V()
 ----
 
+Partitions may also extend to `VertexProperty` elements if the `Graph` can support meta-properties and if the `includeMetaProperties` value is set to `true` when the `PartitionStrategy` is built.  The `partitionKey` will be stored in the meta-properties of the `VertexProperty` and blind the traversal to those properties.  Please note that the `VertexProperty` will only be hidden by way of the `Traversal` itself.  For example, calling `Vertex.property(k)` bypasses the context of the `PartitionStrategy` and will thus allow all properties to be accessed.
+
 By writing elements to particular partitions and then restricting read partitions, the developer is able to create multiple graphs within a single address space. Moreover, by supporting references between partitions, it is possible to merge those multiple graphs (i.e. join partitions).
 
 ReadOnlyStrategy