| <!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>HCatalogIO (Apache Beam 2.36.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="HCatalogIO (Apache Beam 2.36.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/sdk/io/hcatalog/HCatalogBeamSchema.html" title="class in org.apache.beam.sdk.io.hcatalog"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/beam/sdk/io/hcatalog/HCatalogIO.Read.html" title="class in org.apache.beam.sdk.io.hcatalog"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/sdk/io/hcatalog/HCatalogIO.html" target="_top">Frames</a></li> |
| <li><a href="HCatalogIO.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.hcatalog</div> |
| <h2 title="Class HCatalogIO" class="title">Class HCatalogIO</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.sdk.io.hcatalog.HCatalogIO</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">HCatalogIO</span> |
| extends java.lang.Object</pre> |
| <div class="block">IO to read and write data using HCatalog. |
| |
| <p><b>WARNING:</b>This package requires users to declare their own dependency on |
| org.apache.hive:hive-exec and org.apache.hive.hcatalog. At the time of this Beam release every |
| released version of those packages had a transitive dependency on a version of log4j vulnerable |
| to CVE-2021-44228. We strongly encourage users to pin a non-vulnerable version of log4j when |
| using this package. See <a |
| href="https://issues.apache.org/jira/browse/BEAM-13499">BEAM-13499</a>. |
| |
| <h3>Reading using HCatalog</h3> |
| |
| <p>HCatalog source supports reading of HCatRecord from a HCatalog managed source, for eg. Hive. |
| |
| <p>To configure a HCatalog source, you must specify a metastore URI and a table name. Other |
| optional parameters are database & filter. For instance: |
| |
| <pre><code> |
| Map<String, String> configProperties = new HashMap<>(); |
| configProperties.put("hive.metastore.uris","thrift://metastore-host:port"); |
| |
| pipeline |
| .apply(HCatalogIO.read() |
| .withConfigProperties(configProperties) |
| .withDatabase("default") //optional, assumes default if none specified |
| .withTable("employee") |
| .withFilter(filterString) //optional, may be specified if the table is partitioned |
| </code></pre> |
| |
| <p>HCatalog source supports reading of HCatRecord in an unbounded mode. When run in an unbounded |
| mode, HCatalogIO will continuously poll for new partitions and read that data. If provided with a |
| termination condition, it will stop reading data after the condition is met. |
| |
| <pre><code> |
| pipeline |
| .apply(HCatalogIO.read() |
| .withConfigProperties(configProperties) |
| .withDatabase("default") //optional, assumes default if none specified |
| .withTable("employee") |
| .withPollingInterval(Duration.millis(15000)) // poll for new partitions every 15 seconds |
| .withTerminationCondition(Watch.Growth.afterTotalOf(Duration.millis(60000)))) //optional |
| </code></pre> |
| |
| <h3>Writing using HCatalog</h3> |
| |
| <p>HCatalog sink supports writing of HCatRecord to a HCatalog managed source, for eg. Hive. |
| |
| <p>To configure a HCatalog sink, you must specify a metastore URI and a table name. Other |
| optional parameters are database, partition & batchsize. The destination table should exist |
| beforehand, the transform does not create a new table if it does not exist. For instance: |
| |
| <pre><code> |
| Map<String, String> configProperties = new HashMap<>(); |
| configProperties.put("hive.metastore.uris","thrift://metastore-host:port"); |
| |
| pipeline |
| .apply(...) |
| .apply(HCatalogIO.write() |
| .withConfigProperties(configProperties) |
| .withDatabase("default") //optional, assumes default if none specified |
| .withTable("employee") |
| .withPartition(partitionValues) //optional, may be specified if the table is partitioned |
| .withBatchSize(1024L)) //optional, assumes a default batch size of 1024 if none specified |
| </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/hcatalog/HCatalogIO.Read.html" title="class in org.apache.beam.sdk.io.hcatalog">HCatalogIO.Read</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 using HCatalog.</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/hcatalog/HCatalogIO.Write.html" title="class in org.apache.beam.sdk.io.hcatalog">HCatalogIO.Write</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 write to a HCatalog managed source.</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 <a href="../../../../../../org/apache/beam/sdk/io/hcatalog/HCatalogIO.Read.html" title="class in org.apache.beam.sdk.io.hcatalog">HCatalogIO.Read</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/hcatalog/HCatalogIO.html#read--">read</a></span>()</code> |
| <div class="block">Read data from Hive.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../org/apache/beam/sdk/io/hcatalog/HCatalogIO.Write.html" title="class in org.apache.beam.sdk.io.hcatalog">HCatalogIO.Write</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/sdk/io/hcatalog/HCatalogIO.html#write--">write</a></span>()</code> |
| <div class="block">Write data to Hive.</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="write--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>write</h4> |
| <pre>public static <a href="../../../../../../org/apache/beam/sdk/io/hcatalog/HCatalogIO.Write.html" title="class in org.apache.beam.sdk.io.hcatalog">HCatalogIO.Write</a> write()</pre> |
| <div class="block">Write data to Hive.</div> |
| </li> |
| </ul> |
| <a name="read--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>read</h4> |
| <pre>public static <a href="../../../../../../org/apache/beam/sdk/io/hcatalog/HCatalogIO.Read.html" title="class in org.apache.beam.sdk.io.hcatalog">HCatalogIO.Read</a> read()</pre> |
| <div class="block">Read data from Hive.</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><a href="../../../../../../org/apache/beam/sdk/io/hcatalog/HCatalogBeamSchema.html" title="class in org.apache.beam.sdk.io.hcatalog"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/beam/sdk/io/hcatalog/HCatalogIO.Read.html" title="class in org.apache.beam.sdk.io.hcatalog"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/sdk/io/hcatalog/HCatalogIO.html" target="_top">Frames</a></li> |
| <li><a href="HCatalogIO.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> |