| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>Neo4jIO (Apache Beam 2.38.0-SNAPSHOT)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Neo4jIO (Apache Beam 2.38.0-SNAPSHOT)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Class</li> |
| <li><a href="../../../../../../org/apache/beam/sdk/io/neo4j/Neo4jIO.DriverConfiguration.html" title="class in org.apache.beam.sdk.io.neo4j"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/sdk/io/neo4j/Neo4jIO.html" target="_top">Frames</a></li> |
| <li><a href="Neo4jIO.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.beam.sdk.io.neo4j</div> |
| <h2 title="Class Neo4jIO" class="title">Class Neo4jIO</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.sdk.io.neo4j.Neo4jIO</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre><a href="../../../../../../org/apache/beam/sdk/annotations/Experimental.html" title="annotation in org.apache.beam.sdk.annotations">@Experimental</a>(<a href="../../../../../../org/apache/beam/sdk/annotations/Experimental.html#value--">value</a>=<a href="../../../../../../org/apache/beam/sdk/annotations/Experimental.Kind.html#SOURCE_SINK">SOURCE_SINK</a>) |
| public class <span class="typeNameLabel">Neo4jIO</span> |
| extends java.lang.Object</pre> |
| <div class="block">This is a Beam IO to read from, and write data to, Neo4j. |
| |
| <p> |
| |
| <p> |
| |
| <h3>Driver configuration</h3> |
| |
| <p>To read from or write to Neo4j you have to provide a <a href="../../../../../../org/apache/beam/sdk/io/neo4j/Neo4jIO.DriverConfiguration.html" title="class in org.apache.beam.sdk.io.neo4j"><code>Neo4jIO.DriverConfiguration</code></a> using<br> |
| <a href="../../../../../../org/apache/beam/sdk/io/neo4j/Neo4jIO.DriverConfiguration.html#create--"><code>Neo4jIO.DriverConfiguration.create()</code></a> or <a href="../../../../../../org/apache/beam/sdk/io/neo4j/Neo4jIO.DriverConfiguration.html#create-java.lang.String-java.lang.String-java.lang.String-"><code>Neo4jIO.DriverConfiguration.create(String, String, |
| String)</code></a> (URL, username and password). Note that subclasses of DriverConfiguration must also be |
| <code>Serializable</code>). <br> |
| At the level of the Neo4j driver configuration you can specify a Neo4j <code>Config</code> object with |
| <a href="../../../../../../org/apache/beam/sdk/io/neo4j/Neo4jIO.DriverConfiguration.html#withConfig-org.neo4j.driver.Config-"><code>Neo4jIO.DriverConfiguration.withConfig(Config)</code></a>. This way you can configure the Neo4j driver |
| characteristics. Likewise, you can control the characteristics of Neo4j sessions by optionally |
| passing a <code>SessionConfig</code> object to <a href="../../../../../../org/apache/beam/sdk/io/neo4j/Neo4jIO.ReadAll.html" title="class in org.apache.beam.sdk.io.neo4j"><code>Neo4jIO.ReadAll</code></a> or <a href="../../../../../../org/apache/beam/sdk/io/neo4j/Neo4jIO.WriteUnwind.html" title="class in org.apache.beam.sdk.io.neo4j"><code>Neo4jIO.WriteUnwind</code></a>. For example, |
| the session configuration will allow you to target a specific database or set a fetch size. |
| Finally, in even rarer cases you might need to configure the various aspects of Neo4j |
| transactions, for example their timeout. You can do this with a Neo4j <code>TransactionConfig</code> |
| object. |
| |
| <p> |
| |
| <p> |
| |
| <h3>Neo4j Aura</h3> |
| |
| <p>If you have trouble connecting to a Neo4j Aura database please try to disable a few security |
| algorithms in your JVM. This makes sure that the right one is picked to connect: |
| |
| <p> |
| |
| <pre><code> |
| Security.setProperty( |
| "jdk.tls.disabledAlgorithms", |
| "SSLv3, RC4, DES, MD5withRSA, DH keySize < 1024, EC keySize < 224, 3DES_EDE_CBC, anon, NULL"); |
| </code></pre> |
| |
| <p> |
| |
| <p> |
| |
| <p>To execute this code on GCP Dataflow you can create a class which extends <a href="../../../../../../org/apache/beam/sdk/harness/JvmInitializer.html" title="interface in org.apache.beam.sdk.harness"><code>JvmInitializer</code></a> and implement the <a href="../../../../../../org/apache/beam/sdk/harness/JvmInitializer.html#onStartup--"><code>JvmInitializer.onStartup()</code></a> method. You need to annotate |
| this new class with <code>AutoService</code> |
| |
| <pre>{@code</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/neo4j/Neo4jIO.DriverConfiguration.html" title="class in org.apache.beam.sdk.io.neo4j">Neo4jIO.DriverConfiguration</a></span></code> |
| <div class="block">This describes all the information needed to create a Neo4j <code>Session</code>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/neo4j/Neo4jIO.DriverProviderFromDriverConfiguration.html" title="class in org.apache.beam.sdk.io.neo4j">Neo4jIO.DriverProviderFromDriverConfiguration</a></span></code> |
| <div class="block">Wraps a <a href="../../../../../../org/apache/beam/sdk/io/neo4j/Neo4jIO.DriverConfiguration.html" title="class in org.apache.beam.sdk.io.neo4j"><code>Neo4jIO.DriverConfiguration</code></a> to provide a <code>Driver</code>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/neo4j/Neo4jIO.ReadAll.html" title="class in org.apache.beam.sdk.io.neo4j">Neo4jIO.ReadAll</a><<a href="../../../../../../org/apache/beam/sdk/io/neo4j/Neo4jIO.ReadAll.html" title="type parameter in Neo4jIO.ReadAll">ParameterT</a>,<a href="../../../../../../org/apache/beam/sdk/io/neo4j/Neo4jIO.ReadAll.html" title="type parameter in Neo4jIO.ReadAll">OutputT</a>></span></code> |
| <div class="block">This is the class which handles the work behind the <a href="../../../../../../org/apache/beam/sdk/io/neo4j/Neo4jIO.html#readAll--"><code>readAll()</code></a> method.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static interface </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/neo4j/Neo4jIO.RowMapper.html" title="interface in org.apache.beam.sdk.io.neo4j">Neo4jIO.RowMapper</a><<a href="../../../../../../org/apache/beam/sdk/io/neo4j/Neo4jIO.RowMapper.html" title="type parameter in Neo4jIO.RowMapper">T</a>></span></code> |
| <div class="block">An interface used by <a href="../../../../../../org/apache/beam/sdk/io/neo4j/Neo4jIO.ReadAll.html" title="class in org.apache.beam.sdk.io.neo4j"><code>Neo4jIO.ReadAll</code></a> for converting each row of a Neo4j <code>Result</code> record |
| <code>Record</code> into an element of the resulting <a href="../../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/neo4j/Neo4jIO.WriteUnwind.html" title="class in org.apache.beam.sdk.io.neo4j">Neo4jIO.WriteUnwind</a><<a href="../../../../../../org/apache/beam/sdk/io/neo4j/Neo4jIO.WriteUnwind.html" title="type parameter in Neo4jIO.WriteUnwind">ParameterT</a>></span></code> |
| <div class="block">This is the class which handles the work behind the <a href="../../../../../../org/apache/beam/sdk/io/neo4j/Neo4jIO.html#writeUnwind--"><code>writeUnwind()</code></a> method.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/neo4j/Neo4jIO.html#Neo4jIO--">Neo4jIO</a></span>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>static <ParameterT,OutputT><br><a href="../../../../../../org/apache/beam/sdk/io/neo4j/Neo4jIO.ReadAll.html" title="class in org.apache.beam.sdk.io.neo4j">Neo4jIO.ReadAll</a><ParameterT,OutputT></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/neo4j/Neo4jIO.html#readAll--">readAll</a></span>()</code> |
| <div class="block">Read all rows using a Neo4j Cypher query.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <ParameterT><br><a href="../../../../../../org/apache/beam/sdk/io/neo4j/Neo4jIO.WriteUnwind.html" title="class in org.apache.beam.sdk.io.neo4j">Neo4jIO.WriteUnwind</a><ParameterT></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/neo4j/Neo4jIO.html#writeUnwind--">writeUnwind</a></span>()</code> |
| <div class="block">Write all rows using a Neo4j Cypher UNWIND cypher statement.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="Neo4jIO--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>Neo4jIO</h4> |
| <pre>public Neo4jIO()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="readAll--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readAll</h4> |
| <pre>public static <ParameterT,OutputT> <a href="../../../../../../org/apache/beam/sdk/io/neo4j/Neo4jIO.ReadAll.html" title="class in org.apache.beam.sdk.io.neo4j">Neo4jIO.ReadAll</a><ParameterT,OutputT> readAll()</pre> |
| <div class="block">Read all rows using a Neo4j Cypher query.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>ParameterT</code> - Type of the data representing query parameters.</dd> |
| <dd><code>OutputT</code> - Type of the data to be read.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="writeUnwind--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>writeUnwind</h4> |
| <pre>public static <ParameterT> <a href="../../../../../../org/apache/beam/sdk/io/neo4j/Neo4jIO.WriteUnwind.html" title="class in org.apache.beam.sdk.io.neo4j">Neo4jIO.WriteUnwind</a><ParameterT> writeUnwind()</pre> |
| <div class="block">Write all rows using a Neo4j Cypher UNWIND cypher statement. This sets a default batch size of |
| 5000.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>ParameterT</code> - Type of the data representing query parameters.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Class</li> |
| <li><a href="../../../../../../org/apache/beam/sdk/io/neo4j/Neo4jIO.DriverConfiguration.html" title="class in org.apache.beam.sdk.io.neo4j"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/sdk/io/neo4j/Neo4jIO.html" target="_top">Frames</a></li> |
| <li><a href="Neo4jIO.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
