| <!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>DebeziumIO (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="DebeziumIO (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><a href="../../../../../org/apache/beam/io/debezium/Connectors.html" title="enum in org.apache.beam.io.debezium"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/beam/io/debezium/DebeziumIO.ConnectorConfiguration.html" title="class in org.apache.beam.io.debezium"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/beam/io/debezium/DebeziumIO.html" target="_top">Frames</a></li> |
| <li><a href="DebeziumIO.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.io.debezium</div> |
| <h2 title="Class DebeziumIO" class="title">Class DebeziumIO</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.io.debezium.DebeziumIO</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">DebeziumIO</span> |
| extends java.lang.Object</pre> |
| <div class="block">Utility class which exposes an implementation <a href="../../../../../org/apache/beam/io/debezium/DebeziumIO.html#read--"><code>read()</code></a> and a Debezium configuration. |
| |
| <h3>Quick Overview</h3> |
| |
| <p>This class lets Beam users connect to their existing Debezium implementations in an easy way. |
| |
| <p>Any Kafka connector supported by Debezium should work fine with this IO. |
| |
| <p>The following connectors were tested and worked well in some simple scenarios: |
| |
| <ul> |
| <li>MySQL |
| <li>PostgreSQL |
| <li>SQLServer |
| <li>DB2 |
| </ul> |
| |
| <h3>Usage example</h3> |
| |
| <p>Connect to a Debezium - MySQL database and run a Pipeline |
| |
| <pre> |
| private static final ConnectorConfiguration mySqlConnectorConfig = ConnectorConfiguration |
| .create() |
| .withUsername("uname") |
| .withPassword("pwd123") |
| .withHostName("127.0.0.1") |
| .withPort("3306") |
| .withConnectorClass(MySqlConnector.class) |
| .withConnectionProperty("database.server.id", "184054") |
| .withConnectionProperty("database.server.name", "serverid") |
| .withConnectionProperty("database.include.list", "dbname") |
| .withConnectionProperty("database.history", DebeziumSDFDatabaseHistory.class.getName()) |
| .withConnectionProperty("include.schema.changes", "false"); |
| |
| PipelineOptions options = PipelineOptionsFactory.create(); |
| Pipeline p = Pipeline.create(options); |
| p.apply(DebeziumIO.read() |
| .withConnectorConfiguration(mySqlConnectorConfig) |
| .withFormatFunction(new SourceRecordJson.SourceRecordJsonMapper()) |
| ).setCoder(StringUtf8Coder.of()); |
| p.run().waitUntilFinish(); |
| </pre> |
| |
| <p>In this example we are using <a href="../../../../../org/apache/beam/io/debezium/KafkaSourceConsumerFn.DebeziumSDFDatabaseHistory.html" title="class in org.apache.beam.io.debezium"><code>KafkaSourceConsumerFn.DebeziumSDFDatabaseHistory</code></a> to |
| handle the Database history. |
| |
| <h3>Dependencies</h3> |
| |
| <p>User may work with any of the supported Debezium Connectors above mentioned |
| |
| <p>See <a href="https://debezium.io/documentation/reference/1.3/connectors/index.html">Debezium |
| Connectors</a> for more info.</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/io/debezium/DebeziumIO.ConnectorConfiguration.html" title="class in org.apache.beam.io.debezium">DebeziumIO.ConnectorConfiguration</a></span></code> |
| <div class="block">A POJO describing a Debezium configuration.</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/io/debezium/DebeziumIO.Read.html" title="class in org.apache.beam.io.debezium">DebeziumIO.Read</a><<a href="../../../../../org/apache/beam/io/debezium/DebeziumIO.Read.html" title="type parameter in DebeziumIO.Read">T</a>></span></code> |
| <div class="block">Implementation of <a href="../../../../../org/apache/beam/io/debezium/DebeziumIO.html#read--"><code>read()</code></a>.</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/io/debezium/DebeziumIO.Read.html" title="class in org.apache.beam.io.debezium">DebeziumIO.Read</a><T></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/io/debezium/DebeziumIO.html#read--">read</a></span>()</code> |
| <div class="block">Read data from a Debezium source.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/beam/io/debezium/DebeziumIO.Read.html" title="class in org.apache.beam.io.debezium">DebeziumIO.Read</a><java.lang.String></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/io/debezium/DebeziumIO.html#readAsJson--">readAsJson</a></span>()</code> |
| <div class="block">Read data from Debezium source and convert a Kafka <code>SourceRecord</code> into a JSON string using <a href="../../../../../org/apache/beam/io/debezium/SourceRecordJson.SourceRecordJsonMapper.html" title="class in org.apache.beam.io.debezium"><code>SourceRecordJson.SourceRecordJsonMapper</code></a> as default function |
| mapper.</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/io/debezium/DebeziumIO.Read.html" title="class in org.apache.beam.io.debezium">DebeziumIO.Read</a><T> read()</pre> |
| <div class="block">Read data from a Debezium source.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - Type of the data to be read.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="readAsJson--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>readAsJson</h4> |
| <pre>public static <a href="../../../../../org/apache/beam/io/debezium/DebeziumIO.Read.html" title="class in org.apache.beam.io.debezium">DebeziumIO.Read</a><java.lang.String> readAsJson()</pre> |
| <div class="block">Read data from Debezium source and convert a Kafka <code>SourceRecord</code> into a JSON string using <a href="../../../../../org/apache/beam/io/debezium/SourceRecordJson.SourceRecordJsonMapper.html" title="class in org.apache.beam.io.debezium"><code>SourceRecordJson.SourceRecordJsonMapper</code></a> as default function |
| mapper.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Reader object of String.</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><a href="../../../../../org/apache/beam/io/debezium/Connectors.html" title="enum in org.apache.beam.io.debezium"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/beam/io/debezium/DebeziumIO.ConnectorConfiguration.html" title="class in org.apache.beam.io.debezium"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/beam/io/debezium/DebeziumIO.html" target="_top">Frames</a></li> |
| <li><a href="DebeziumIO.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> |
