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/11/09 23:10:02 UTC
svn commit: r1713558 -
/incubator/tinkerpop/site/docs/3.1.0-SNAPSHOT/upgrade.html
Author: spmallette
Date: Mon Nov 9 22:10:02 2015
New Revision: 1713558
URL: http://svn.apache.org/viewvc?rev=1713558&view=rev
Log:
Updates to 3.1.0 upgrade docs.
Modified:
incubator/tinkerpop/site/docs/3.1.0-SNAPSHOT/upgrade.html
Modified: incubator/tinkerpop/site/docs/3.1.0-SNAPSHOT/upgrade.html
URL: http://svn.apache.org/viewvc/incubator/tinkerpop/site/docs/3.1.0-SNAPSHOT/upgrade.html?rev=1713558&r1=1713557&r2=1713558&view=diff
==============================================================================
--- incubator/tinkerpop/site/docs/3.1.0-SNAPSHOT/upgrade.html (original)
+++ incubator/tinkerpop/site/docs/3.1.0-SNAPSHOT/upgrade.html Mon Nov 9 22:10:02 2015
@@ -807,10 +807,22 @@ span.line-numbers { border-right: 1px so
<li><a href="#_upgrading_for_users">Upgrading for Users</a></li>
<li>
<ul class="sectlevel3">
-<li><a href="#_gremlin_structure">Gremlin Structure</a></li>
-<li><a href="#_gremlin_process">Gremlin Process</a></li>
-<li><a href="#_gremlin_groovy_updates">Gremlin-Groovy Updates</a></li>
-<li><a href="#_gremlin_console">Gremlin Console</a></li>
+<li><a href="#_shading_jackson">Shading Jackson</a></li>
+<li><a href="#_partitionstrategy_and_vertexproperty">PartitionStrategy and VertexProperty</a></li>
+<li><a href="#_gremlin_server_and_epoll">Gremlin Server and Epoll</a></li>
+<li><a href="#_rebindings_deprecated">Rebindings Deprecated</a></li>
+<li><a href="#_configurable_driver_channelizer">Configurable Driver Channelizer</a></li>
+<li><a href="#_graphson_and_strict_option">GraphSON and Strict Option</a></li>
+<li><a href="#_transaction_close_default_behavior">Transaction.close() Default Behavior</a></li>
+<li><a href="#_threadlocal_transaction_settings">ThreadLocal Transaction Settings</a></li>
+<li><a href="#_hadoop_gremlin">Hadoop-Gremlin</a></li>
+<li><a href="#_spark_gremlin">Spark-Gremlin</a></li>
+<li><a href="#_tinkergraph_serialization">TinkerGraph Serialization</a></li>
+<li><a href="#_deprecation_in_tinkergraph">Deprecation in TinkerGraph</a></li>
+<li><a href="#_deprecation_in_gremlin_groovy">Deprecation in Gremlin-Groovy</a></li>
+<li><a href="#_gephi_traversal_visualization">Gephi Traversal Visualization</a></li>
+<li><a href="#_alterations_to_graphtraversal">Alterations to GraphTraversal</a></li>
+<li><a href="#_aliasing_remotes_in_the_console">Aliasing Remotes in the Console</a></li>
</ul>
</li>
<li><a href="#_upgrading_for_providers">Upgrading for Providers</a></li>
@@ -925,6 +937,9 @@ build libraries and other systems on the
<p><strong>Release Date: NOT OFFICIALLY RELEASED YET</strong></p>
</div>
<div class="paragraph">
+<p>Please see the <a href="https://github.com/apache/incubator-tinkerpop/blob/3.1.0-incubating/CHANGELOG.asciidoc#XXXXXXXXXXXXXXXXXXXXXXXXXXXX">changelog-(NOT FINAL)</a> for a complete list of all the modifications that are part of this release.</p>
+</div>
+<div class="paragraph">
<p>Additional upgrade information can be found here:</p>
</div>
<div class="ulist">
@@ -954,47 +969,96 @@ build libraries and other systems on the
<p>The data type of <code>Operator</code> enums will now always be the highest common data type of the two given numbers, rather than the data type of the first number, as it’s been before.</p>
</li>
<li>
-<p>The Gephi Plugin has improved integration with Gephi, where manually inserting <code>store</code> steps to visualize a running traversal is no longer required.</p>
-</li>
-<li>
-<p>Entire TinkerGraph instances can be serialized over Gryo.</p>
-</li>
-<li>
<p>Hadoop1 support has been dropped. Hadoop2 is now supported. Giraph and Spark can work over Hadoop2 YARN.</p>
</li>
<li>
<p>The implementation and semantics of <code>GraphTraversal.group()</code> has changed. The previous model is deprecated and renamed to <code>groupV3d0()</code>.</p>
</li>
+</ul>
+</div>
+</div>
+<div class="sect2">
+<h3 id="_upgrading_for_users">Upgrading for Users</h3>
+<div class="sect3">
+<h4 id="_shading_jackson">Shading Jackson</h4>
+<div class="paragraph">
+<p>The Jackson library is now shaded to <code>gremlin-shaded</code>, which will allow Jackson to version independently without
+breaking compatibility with dependent libraries or with those who depend on TinkerPop. The downside is that if a
+library depends on TinkerPop and uses the Jackson classes, those classes will no longer exist with the standard
+Jackson package naming. They will have to shifted as follows:</p>
+</div>
+<div class="ulist">
+<ul>
<li>
-<p><code>Transaction.onReadWrite()</code> and <code>Transaction.onClose()</code> are now <code>ThreadLocal</code> settings</p>
-</li>
-<li>
-<p><code>PartitionStrategy</code> now supports <code>VertexProperty</code> such those properties can be added to partitions.</p>
-</li>
-<li>
-<p>The Jackson library is now "shaded" and included in the <code>gremlin-shaded</code> module.</p>
-</li>
-<li>
-<p>Configuration for Netty <a href="http://netty.io/wiki/native-transports.html">native transport</a> support in Gremlin Server.</p>
+<p><code>org.objenesis</code> becomes <code>org.apache.tinkerpop.shaded.objenesis</code></p>
</li>
<li>
-<p>The <code>Channelizer</code> implementation for Gremlin Driver can now be changed via configuration.</p>
+<p><code>com.esotericsoftware.minlog</code> becomes <code>org.apache.tinkerpop.shaded.minlog</code></p>
</li>
<li>
-<p>TinkerGraph is now serializable over Gryo so it is possible to request subgraphs via Gremlin Server (and <code>:remote</code>).</p>
+<p><code>com.fasterxml.jackson</code> becomes <code>org.apache.tinkerpop.shaded.jackson</code></p>
</li>
</ul>
</div>
<div class="paragraph">
-<p>Please see the <a href="https://github.com/apache/incubator-tinkerpop/blob/3.1.0-incubating/CHANGELOG.asciidoc#XXXXXXXXXXXXXXXXXXXXXXXXXXXX">changelog</a> for a complete list of all the modifications that are part of this release.</p>
+<p>See: <a href="https://issues.apache.org/jira/browse/TINKERPOP3-835">TINKERPOP3-835</a></p>
</div>
</div>
-<div class="sect2">
-<h3 id="_upgrading_for_users">Upgrading for Users</h3>
<div class="sect3">
-<h4 id="_gremlin_structure">Gremlin Structure</h4>
-<div class="sect4">
-<h5 id="_transaction_close_default_behavior">Transaction.close() Default Behavior</h5>
+<h4 id="_partitionstrategy_and_vertexproperty">PartitionStrategy and VertexProperty</h4>
+<div class="paragraph">
+<p><code>PartitionStrategy</code> now supports partitioning within <code>VertexProperty</code>. The <code>Graph</code> needs to be able to support
+meta-properties for this feature to work.</p>
+</div>
+<div class="paragraph">
+<p>See: <a href="https://issues.apache.org/jira/browse/TINKERPOP3-333">TINKERPOP3-333</a></p>
+</div>
+</div>
+<div class="sect3">
+<h4 id="_gremlin_server_and_epoll">Gremlin Server and Epoll</h4>
+<div class="paragraph">
+<p>Gremlin Server provides a configuration option to turn on support for Netty
+<a href="http://netty.io/wiki/native-transports.html">native transport</a> on Linux, which has been shown to help improve
+performance.</p>
+</div>
+<div class="paragraph">
+<p>See: <a href="https://issues.apache.org/jira/browse/TINKERPOP3-901">TINKERPOP3-901</a></p>
+</div>
+</div>
+<div class="sect3">
+<h4 id="_rebindings_deprecated">Rebindings Deprecated</h4>
+<div class="paragraph">
+<p>The notion of "rebindings" has been deprecated in favor of the term "aliases". Alias is a better and more intuitive
+term than rebindings which should make it easier for newcomers to understand what they are for.</p>
+</div>
+<div class="paragraph">
+<p>See: <a href="https://issues.apache.org/jira/browse/TINKERPOP3-913">TINKERPOP3-913</a>,
+<a href="http://tinkerpop.incubator.apache.org/docs/3.1.0-incubating/#_aliases">Reference Documentation - Aliases</a></p>
+</div>
+</div>
+<div class="sect3">
+<h4 id="_configurable_driver_channelizer">Configurable Driver Channelizer</h4>
+<div class="paragraph">
+<p>The Gremlin Driver now allows the <code>Channerlizer</code> to be supplied as a configuration, which means that custom
+implementations may be supplied.</p>
+</div>
+<div class="paragraph">
+<p>See: <a href="https://issues.apache.org/jira/browse/TINKERPOP3-680">TINKERPOP3-680</a></p>
+</div>
+</div>
+<div class="sect3">
+<h4 id="_graphson_and_strict_option">GraphSON and Strict Option</h4>
+<div class="paragraph">
+<p>The <code>GraphMLReader</code> now has a <code>strict</code> option on the <code>Builder</code> so that if a data type for a value is invalid in some
+way, GraphMLReader will simply skip that problem value. In that way, it is a bit more forgiving than before especially
+with empty data.</p>
+</div>
+<div class="paragraph">
+<p>See: <a href="https://issues.apache.org/jira/browse/TINKERPOP3-756">TINKERPOP3-756</a></p>
+</div>
+</div>
+<div class="sect3">
+<h4 id="_transaction_close_default_behavior">Transaction.close() Default Behavior</h4>
<div class="paragraph">
<p>The default behavior of <code>Transaction.close()</code> is to rollback the transaction. This is in contrast to previous versions
where the default behavior was commit. Using rollback as the default should be thought of as a like a safer approach
@@ -1004,8 +1068,8 @@ to closing where a user must now explici
<p>See <a href="https://issues.apache.org/jira/browse/TINKERPOP3-805">TINKERPOP3-805</a> for more information.</p>
</div>
</div>
-<div class="sect4">
-<h5 id="_threadlocal_transaction_settings">ThreadLocal Transaction Settings</h5>
+<div class="sect3">
+<h4 id="_threadlocal_transaction_settings">ThreadLocal Transaction Settings</h4>
<div class="paragraph">
<p>The <code>Transaction.onReadWrite()</code> and <code>Transaction.onClose()</code> settings now need to be set for each thread (if another
behavior than the default is desired). For gremlin-server users that may be changing these settings via scripts.
@@ -1016,8 +1080,8 @@ changed for an in-session request they w
<p>See <a href="https://issues.apache.org/jira/browse/TINKERPOP3-885">TINKERPOP3-885</a></p>
</div>
</div>
-<div class="sect4">
-<h5 id="_hadoop_gremlin_updates">Hadoop-Gremlin Updates</h5>
+<div class="sect3">
+<h4 id="_hadoop_gremlin">Hadoop-Gremlin</h4>
<div class="ulist">
<ul>
<li>
@@ -1039,8 +1103,8 @@ changed for an in-session request they w
</ul>
</div>
</div>
-<div class="sect4">
-<h5 id="_spark_gremlin_updates">Spark-Gremlin Updates</h5>
+<div class="sect3">
+<h4 id="_spark_gremlin">Spark-Gremlin</h4>
<div class="ulist">
<ul>
<li>
@@ -1056,21 +1120,63 @@ changed for an in-session request they w
</ul>
</div>
</div>
-<div class="sect4">
-<h5 id="_tinkergraph_gremlin_updates">TinkerGraph-Gremlin Updates</h5>
-<div class="ulist">
-<ul>
-<li>
-<p>The <code>public static String</code> configurations have been renamed. The old <code>public static</code> variables have been deprecated.</p>
-</li>
-</ul>
+<div class="sect3">
+<h4 id="_tinkergraph_serialization">TinkerGraph Serialization</h4>
+<div class="paragraph">
+<p>TinkerGraph is serializable over Gryo, which means that it can shipped over the wire from Gremlin Server. This
+feature can be useful when working with remote subgraphs.</p>
</div>
+<div class="paragraph">
+<p>See: <a href="https://issues.apache.org/jira/browse/TINKERPOP3-728">TINKERPOP3-728</a></p>
</div>
</div>
<div class="sect3">
-<h4 id="_gremlin_process">Gremlin Process</h4>
-<div class="sect4">
-<h5 id="_graph_traversal_updates">Graph Traversal Updates</h5>
+<h4 id="_deprecation_in_tinkergraph">Deprecation in TinkerGraph</h4>
+<div class="paragraph">
+<p>The <code>public static String</code> configurations have been renamed. The old <code>public static</code> variables have been deprecated.
+If the deprecated variables were being used, then convert to the replacements as soon as possible.</p>
+</div>
+<div class="paragraph">
+<p>See: <a href="https://issues.apache.org/jira/browse/TINKERPOP3-926">TINKERPOP3-926</a></p>
+</div>
+</div>
+<div class="sect3">
+<h4 id="_deprecation_in_gremlin_groovy">Deprecation in Gremlin-Groovy</h4>
+<div class="paragraph">
+<p>The closure wrappers classes <code>GFunction</code>, <code>GSupplier</code>, <code>GConsumer</code> have been deprecated. In Groovy, a closure can be
+specified using <code>as Function</code> and thus, these wrappers are not needed. Also, the <code>GremlinExecutor.promoteBindings()</code>
+method which was previously deprecated has been removed.</p>
+</div>
+<div class="paragraph">
+<p>See: <a href="https://issues.apache.org/jira/browse/TINKERPOP3-879">TINKERPOP3-879</a>,
+<a href="https://issues.apache.org/jira/browse/TINKERPOP3-897">TINKERPOP3-897</a></p>
+</div>
+</div>
+<div class="sect3">
+<h4 id="_gephi_traversal_visualization">Gephi Traversal Visualization</h4>
+<div class="paragraph">
+<p>The process for visualizing a traversal has been simplified. There is no longer a need to "name" steps that will
+represent visualization points for Gephi. It is possible to just "configure" a <code>visualTraversal</code> in the console:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="CodeRay"><code class="text language-text">gremlin> :remote config visualTraversal graph vg</code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>which creates a special <code>TraversalSource</code> from <code>graph</code> called <code>vg</code>. The traversals created from <code>vg</code> can be used
+to <code>:submit</code> to Gephi.</p>
+</div>
+<div class="paragraph">
+<p>See: <a href="http://tinkerpop.incubator.apache.org/docs/3.1.0-SNAPSHOT/#gephi-plugin">Reference Documentation - Gephi</a></p>
+</div>
+</div>
+<div class="sect3">
+<h4 id="_alterations_to_graphtraversal">Alterations to GraphTraversal</h4>
+<div class="paragraph">
+<p>There were a number of changes to <code>GraphTraversal</code>. Many of the changes came by way of deprecation, but some semantics
+have changed as well:</p>
+</div>
<div class="ulist">
<ul>
<li>
@@ -1138,31 +1244,8 @@ changed for an in-session request they w
</ul>
</div>
</div>
-</div>
<div class="sect3">
-<h4 id="_gremlin_groovy_updates">Gremlin-Groovy Updates</h4>
-<div class="ulist">
-<ul>
-<li>
-<p>The closure wrappers classes <code>GFunction</code>, <code>GSupplier</code>, <code>GConsumer</code> have been deprecated.</p>
-<div class="ulist">
-<ul>
-<li>
-<p>In Groovy, a closure can be specified using <code>as Function</code> and thus, these wrappers are not needed.</p>
-</li>
-</ul>
-</div>
-</li>
-<li>
-<p>The <code>GremlinExecutor.promoteBindings()</code> method which was previously deprecated has been removed.</p>
-</li>
-</ul>
-</div>
-</div>
-<div class="sect3">
-<h4 id="_gremlin_console">Gremlin Console</h4>
-<div class="sect4">
-<h5 id="_aliasing_remotes">Aliasing Remotes</h5>
+<h4 id="_aliasing_remotes_in_the_console">Aliasing Remotes in the Console</h4>
<div class="paragraph">
<p>The <code>:remote</code> command in Gremlin Console has a new <code>alias</code> configuration option. This <code>alias</code> option allows
specification of a set of key/value alias/binding pairs to apply to the remote. In this way, it becomes possible
@@ -1182,6 +1265,8 @@ script. For example once a <code>:remot
<pre class="CodeRay"><code class="text language-text">:> x.E().label().groupCount()</code></pre>
</div>
</div>
+<div class="paragraph">
+<p>See: <a href="https://issues.apache.org/jira/browse/TINKERPOP3-914">TINKERPOP3-914</a></p>
</div>
</div>
</div>
@@ -1218,8 +1303,8 @@ are supplied in <code>AbstractThreadLoca
</ul>
</div>
<div class="paragraph">
-<p>See <a href="https://issues.apache.org/jira/browse/TINKERPOP3-765">TINKERPOP3-765</a> and
-<a href="https://issues.apache.org/jira/browse/TINKERPOP3-885">TINKERPOP3-885</a> for more information.</p>
+<p>See: <a href="https://issues.apache.org/jira/browse/TINKERPOP3-765">TINKERPOP3-765</a>,
+<a href="https://issues.apache.org/jira/browse/TINKERPOP3-885">TINKERPOP3-885</a></p>
</div>
</div>
<div class="sect4">
@@ -1242,11 +1327,11 @@ previously asserted the opposite (i.e. c
<p>If these tests were referenced in an <code>OptOut</code>, then their names should be updated.</p>
</div>
<div class="paragraph">
-<p>See <a href="https://issues.apache.org/jira/browse/TINKERPOP3-805">TINKERPOP3-805</a> for more information.</p>
+<p>See: <a href="https://issues.apache.org/jira/browse/TINKERPOP3-805">TINKERPOP3-805</a></p>
</div>
</div>
<div class="sect4">
-<h5 id="_graph_traversal_updates_2">Graph Traversal Updates</h5>
+<h5 id="_graph_traversal_updates">Graph Traversal Updates</h5>
<div class="paragraph">
<p>There were numerous changes to the <code>GraphTraversal</code> API. Nearly all changes are backwards compatible with respective
"deprecated" annotations. Please review the respective updates specified in the "Graph System Users" section.</p>
@@ -1272,7 +1357,7 @@ previously asserted the opposite (i.e. c
Providers are free to deal with deleted elements as they see fit.</p>
</div>
<div class="paragraph">
-<p>See <a href="https://issues.apache.org/jira/browse/TINKERPOP3-297">TINKERPOP3-297</a> for more information.</p>
+<p>See: <a href="https://issues.apache.org/jira/browse/TINKERPOP3-297">TINKERPOP3-297</a></p>
</div>
</div>
<div class="sect4">
@@ -1282,7 +1367,7 @@ previously asserted the opposite (i.e. c
with revised terminology for what were formerly referred to as "vendors".</p>
</div>
<div class="paragraph">
-<p>See <a href="https://issues.apache.org/jira/browse/TINKERPOP3-876">TINKERPOP3-876</a> for more information.</p>
+<p>See: <a href="https://issues.apache.org/jira/browse/TINKERPOP3-876">TINKERPOP3-876</a></p>
</div>
</div>
<div class="sect4">
@@ -1306,7 +1391,7 @@ the future. Gremlin Server will not acc
parameter or the other if either is supplied.</p>
</div>
<div class="paragraph">
-<p>See <a href="https://issues.apache.org/jira/browse/TINKERPOP3-913">TINKERPOP3-913</a> for more information.</p>
+<p>See: <a href="https://issues.apache.org/jira/browse/TINKERPOP3-913">TINKERPOP3-913</a></p>
</div>
</div>
<div class="sect4">
@@ -1318,7 +1403,7 @@ that one request. If the settings are ch
made in the scope of that session.</p>
</div>
<div class="paragraph">
-<p>See <a href="https://issues.apache.org/jira/browse/TINKERPOP3-885">TINKERPOP3-885</a> for more information.</p>
+<p>See: <a href="https://issues.apache.org/jira/browse/TINKERPOP3-885">TINKERPOP3-885</a></p>
</div>
</div>
</div>
@@ -1348,13 +1433,13 @@ made in the scope of that session.</p>
<div class="sect3">
<h4 id="_bulkloadervertexprogram_blvp">BulkLoaderVertexProgram (BLVP)</h4>
<div class="paragraph">
-<p><code>BulkLoaderVertexProgram</code> does now support arbitrary inputs (besides the <code>HadoopGraph</code>, which was already supported in
-version 3.0.1-incubating, <code>BulkLoaderVertexProgram</code> can now also read from any TP3 enabled graph, like <code>TinkerGraph</code>
-or <code>Neo4jGraph</code>).</p>
+<p><code>BulkLoaderVertexProgram</code> now supports arbitrary inputs (i addition to <code>HadoopGraph</code>, which was already supported in
+version 3.0.1-incubating). It can now also read from any TP3 enabled graph, like <code>TinkerGraph</code>
+or <code>Neo4jGraph</code>.</p>
</div>
<div class="paragraph">
<p>See: <a href="https://issues.apache.org/jira/browse/TINKERPOP3-814">TINKERPOP3-319</a>,
-link:http://tinkerpop.incubator.apache.org/docs/3.0.2-incubating/#bulkloadervertexprogram[Reference Documentation - BLVP)</p>
+<a href="http://tinkerpop.incubator.apache.org/docs/3.0.2-incubating/#bulkloadervertexprogram">Reference Documentation - BLVP</a></p>
</div>
</div>
<div class="sect3">
@@ -1525,7 +1610,7 @@ want the security capabilities that it p
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2015-11-09 15:33:42 -05:00
+Last updated 2015-11-09 17:03:54 -05:00
</div>
</div>
</body>