| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- GitHub action javadoc-cleanup --> |
| <link rel="canonical" href="https://beam.apache.org/releases/javadoc/current/org/apache/beam/sdk/io/cassandra/CassandraIO.html"> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <!-- End javadoc-cleanup block --> |
| <!-- Generated by javadoc --> |
| <title>CassandraIO (Apache Beam 2.55.1)</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="CassandraIO (Apache Beam 2.55.1)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":9,"i2":9,"i3":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/cassandra/CassandraIO.MutationType.html" title="enum in org.apache.beam.sdk.io.cassandra"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/sdk/io/cassandra/CassandraIO.html" target="_top">Frames</a></li> |
| <li><a href="CassandraIO.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>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.cassandra</div> |
| <h2 title="Class CassandraIO" class="title">Class CassandraIO</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.sdk.io.cassandra.CassandraIO</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">CassandraIO</span> |
| extends java.lang.Object</pre> |
| <div class="block">An IO to read and write from/to Apache Cassandra |
| |
| <h3>Reading from Apache Cassandra</h3> |
| |
| <p><code>CassandraIO</code> provides a source to read and returns a bounded collection of entities as |
| <code>PCollection<Entity></code>. An entity is built by Cassandra mapper (<code>com.datastax.driver.mapping.EntityMapper</code>) based on a POJO containing annotations (as described |
| http://docs.datastax .com/en/developer/java-driver/2.1/manual/object_mapper/creating/"). |
| |
| <p>The following example illustrates various options for configuring the IO: |
| |
| <pre><code> |
| pipeline.apply(CassandraIO.<Person>read() |
| .withHosts(Arrays.asList("host1", "host2")) |
| .withPort(9042) |
| .withKeyspace("beam") |
| .withTable("Person") |
| .withEntity(Person.class) |
| .withCoder(SerializableCoder.of(Person.class)) |
| // above options are the minimum set, returns PCollection<Person> |
| |
| </code></pre> |
| |
| <p>Alternatively, one may use <code>CassandraIO.<Person>readAll() |
| .withCoder(SerializableCoder.of(Person.class))</code> to query a subset of the Cassandra database by |
| creating a PCollection of <code>CassandraIO.Read<Person></code> each with their own query or |
| RingRange. |
| |
| <h3>Writing to Apache Cassandra</h3> |
| |
| <p><code>CassandraIO</code> provides a sink to write a collection of entities to Apache Cassandra. |
| |
| <p>The following example illustrates various options for configuring the IO write: |
| |
| <pre><code> |
| pipeline |
| .apply(...) // provides a PCollection<Person> where Person is an entity |
| .apply(CassandraIO.<Person>write() |
| .withHosts(Arrays.asList("host1", "host2")) |
| .withPort(9042) |
| .withKeyspace("beam") |
| .withEntity(Person.class)); |
| </code></pre> |
| |
| <h3>Cassandra Socket Options</h3> |
| |
| <p>The following example illustrates setting timeouts for the Cassandra client: |
| |
| <pre><code> |
| pipeline.apply(CassandraIO.<Person>read() |
| .withHosts(Arrays.asList("host1", "host2")) |
| .withPort(9042) |
| .withConnectTimeout(1000) |
| .withReadTimeout(5000) |
| .withKeyspace("beam") |
| .withTable("Person") |
| .withEntity(Person.class) |
| .withCoder(SerializableCoder.of(Person.class)) |
| </code></pre></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/cassandra/CassandraIO.MutationType.html" title="enum in org.apache.beam.sdk.io.cassandra">CassandraIO.MutationType</a></span></code> |
| <div class="block">Specify the mutation type: either write or delete.</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/cassandra/CassandraIO.Read.html" title="class in org.apache.beam.sdk.io.cassandra">CassandraIO.Read</a><<a href="../../../../../../org/apache/beam/sdk/io/cassandra/CassandraIO.Read.html" title="type parameter in CassandraIO.Read">T</a>></span></code> |
| <div class="block">A <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> to read data from Apache Cassandra.</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/cassandra/CassandraIO.ReadAll.html" title="class in org.apache.beam.sdk.io.cassandra">CassandraIO.ReadAll</a><<a href="../../../../../../org/apache/beam/sdk/io/cassandra/CassandraIO.ReadAll.html" title="type parameter in CassandraIO.ReadAll">T</a>></span></code> |
| <div class="block">A <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> to read data from Apache Cassandra.</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/cassandra/CassandraIO.Write.html" title="class in org.apache.beam.sdk.io.cassandra">CassandraIO.Write</a><<a href="../../../../../../org/apache/beam/sdk/io/cassandra/CassandraIO.Write.html" title="type parameter in CassandraIO.Write">T</a>></span></code> |
| <div class="block">A <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> to mutate into Apache Cassandra.</div> |
| </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 <T> <a href="../../../../../../org/apache/beam/sdk/io/cassandra/CassandraIO.Write.html" title="class in org.apache.beam.sdk.io.cassandra">CassandraIO.Write</a><T></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/cassandra/CassandraIO.html#delete--">delete</a></span>()</code> |
| <div class="block">Provide a <a href="../../../../../../org/apache/beam/sdk/io/cassandra/CassandraIO.Write.html" title="class in org.apache.beam.sdk.io.cassandra"><code>CassandraIO.Write</code></a> <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> to delete data to a Cassandra database.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <T> <a href="../../../../../../org/apache/beam/sdk/io/cassandra/CassandraIO.Read.html" title="class in org.apache.beam.sdk.io.cassandra">CassandraIO.Read</a><T></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/cassandra/CassandraIO.html#read--">read</a></span>()</code> |
| <div class="block">Provide a <a href="../../../../../../org/apache/beam/sdk/io/cassandra/CassandraIO.Read.html" title="class in org.apache.beam.sdk.io.cassandra"><code>CassandraIO.Read</code></a> <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> to read data from a Cassandra database.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static <T> <a href="../../../../../../org/apache/beam/sdk/io/cassandra/CassandraIO.ReadAll.html" title="class in org.apache.beam.sdk.io.cassandra">CassandraIO.ReadAll</a><T></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/cassandra/CassandraIO.html#readAll--">readAll</a></span>()</code> |
| <div class="block">Provide a <a href="../../../../../../org/apache/beam/sdk/io/cassandra/CassandraIO.ReadAll.html" title="class in org.apache.beam.sdk.io.cassandra"><code>CassandraIO.ReadAll</code></a> <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> to read data from a Cassandra database.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static <T> <a href="../../../../../../org/apache/beam/sdk/io/cassandra/CassandraIO.Write.html" title="class in org.apache.beam.sdk.io.cassandra">CassandraIO.Write</a><T></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/cassandra/CassandraIO.html#write--">write</a></span>()</code> |
| <div class="block">Provide a <a href="../../../../../../org/apache/beam/sdk/io/cassandra/CassandraIO.Write.html" title="class in org.apache.beam.sdk.io.cassandra"><code>CassandraIO.Write</code></a> <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> to write data to a Cassandra database.</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"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="read--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>read</h4> |
| <pre>public static <T> <a href="../../../../../../org/apache/beam/sdk/io/cassandra/CassandraIO.Read.html" title="class in org.apache.beam.sdk.io.cassandra">CassandraIO.Read</a><T> read()</pre> |
| <div class="block">Provide a <a href="../../../../../../org/apache/beam/sdk/io/cassandra/CassandraIO.Read.html" title="class in org.apache.beam.sdk.io.cassandra"><code>CassandraIO.Read</code></a> <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> to read data from a Cassandra database.</div> |
| </li> |
| </ul> |
| <a name="readAll--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>readAll</h4> |
| <pre>public static <T> <a href="../../../../../../org/apache/beam/sdk/io/cassandra/CassandraIO.ReadAll.html" title="class in org.apache.beam.sdk.io.cassandra">CassandraIO.ReadAll</a><T> readAll()</pre> |
| <div class="block">Provide a <a href="../../../../../../org/apache/beam/sdk/io/cassandra/CassandraIO.ReadAll.html" title="class in org.apache.beam.sdk.io.cassandra"><code>CassandraIO.ReadAll</code></a> <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> to read data from a Cassandra database.</div> |
| </li> |
| </ul> |
| <a name="write--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>write</h4> |
| <pre>public static <T> <a href="../../../../../../org/apache/beam/sdk/io/cassandra/CassandraIO.Write.html" title="class in org.apache.beam.sdk.io.cassandra">CassandraIO.Write</a><T> write()</pre> |
| <div class="block">Provide a <a href="../../../../../../org/apache/beam/sdk/io/cassandra/CassandraIO.Write.html" title="class in org.apache.beam.sdk.io.cassandra"><code>CassandraIO.Write</code></a> <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> to write data to a Cassandra database.</div> |
| </li> |
| </ul> |
| <a name="delete--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>delete</h4> |
| <pre>public static <T> <a href="../../../../../../org/apache/beam/sdk/io/cassandra/CassandraIO.Write.html" title="class in org.apache.beam.sdk.io.cassandra">CassandraIO.Write</a><T> delete()</pre> |
| <div class="block">Provide a <a href="../../../../../../org/apache/beam/sdk/io/cassandra/CassandraIO.Write.html" title="class in org.apache.beam.sdk.io.cassandra"><code>CassandraIO.Write</code></a> <a href="../../../../../../org/apache/beam/sdk/transforms/PTransform.html" title="class in org.apache.beam.sdk.transforms"><code>PTransform</code></a> to delete data to a Cassandra database.</div> |
| </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/cassandra/CassandraIO.MutationType.html" title="enum in org.apache.beam.sdk.io.cassandra"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/sdk/io/cassandra/CassandraIO.html" target="_top">Frames</a></li> |
| <li><a href="CassandraIO.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>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |