blob: ace72c0d4377fb7be7a33ac23124dce28351816f [file] [log] [blame]
<!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 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>MetadataMapper (Drill : 1.20.3 API)</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="MetadataMapper (Drill : 1.20.3 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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="class-use/MetadataMapper.html">Use</a></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/drill/metastore/rdbms/transform/AbstractTransformer.html" title="class in org.apache.drill.metastore.rdbms.transform"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/drill/metastore/rdbms/transform/RdbmsFilterExpressionVisitor.html" title="class in org.apache.drill.metastore.rdbms.transform"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/drill/metastore/rdbms/transform/MetadataMapper.html" target="_top">Frames</a></li>
<li><a href="MetadataMapper.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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.drill.metastore.rdbms.transform</div>
<h2 title="Interface MetadataMapper" class="title">Interface MetadataMapper&lt;U,R extends org.jooq.Record&gt;</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>U</code> - Metastore component metadata type</dd>
<dd><code>R</code> - RDBMS table record type</dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../../org/apache/drill/metastore/rdbms/transform/AbstractMetadataMapper.html" title="class in org.apache.drill.metastore.rdbms.transform">AbstractMetadataMapper</a>, <a href="../../../../../../org/apache/drill/metastore/rdbms/components/tables/TablesMetadataMapper.html" title="class in org.apache.drill.metastore.rdbms.components.tables">TablesMetadataMapper</a>, <a href="../../../../../../org/apache/drill/metastore/rdbms/components/tables/TablesMetadataMapper.FileMapper.html" title="class in org.apache.drill.metastore.rdbms.components.tables">TablesMetadataMapper.FileMapper</a>, <a href="../../../../../../org/apache/drill/metastore/rdbms/components/tables/TablesMetadataMapper.PartitionMapper.html" title="class in org.apache.drill.metastore.rdbms.components.tables">TablesMetadataMapper.PartitionMapper</a>, <a href="../../../../../../org/apache/drill/metastore/rdbms/components/tables/TablesMetadataMapper.RowGroupMapper.html" title="class in org.apache.drill.metastore.rdbms.components.tables">TablesMetadataMapper.RowGroupMapper</a>, <a href="../../../../../../org/apache/drill/metastore/rdbms/components/tables/TablesMetadataMapper.SegmentMapper.html" title="class in org.apache.drill.metastore.rdbms.components.tables">TablesMetadataMapper.SegmentMapper</a>, <a href="../../../../../../org/apache/drill/metastore/rdbms/components/tables/TablesMetadataMapper.TableMapper.html" title="class in org.apache.drill.metastore.rdbms.components.tables">TablesMetadataMapper.TableMapper</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">MetadataMapper&lt;U,R extends org.jooq.Record&gt;</span></pre>
<div class="block">Provides various mapping, transformation methods for the given
RDBMS table and Metastore component metadata unit.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</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><a href="../../../../../../org/apache/drill/metastore/rdbms/transform/MetadataMapper.html" title="type parameter in MetadataMapper">U</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/metastore/rdbms/transform/MetadataMapper.html#emptyUnit--">emptyUnit</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>org.jooq.Table&lt;<a href="../../../../../../org/apache/drill/metastore/rdbms/transform/MetadataMapper.html" title="type parameter in MetadataMapper">R</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/metastore/rdbms/transform/MetadataMapper.html#table--">table</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>org.jooq.Condition</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/metastore/rdbms/transform/MetadataMapper.html#toCondition-org.apache.drill.metastore.expressions.FilterExpression-">toCondition</a></span>(<a href="../../../../../../org/apache/drill/metastore/expressions/FilterExpression.html" title="interface in org.apache.drill.metastore.expressions">FilterExpression</a>&nbsp;filter)</code>
<div class="block">Converts Metastore filter expression into JOOQ condition instance
which will be used as where clause in SQL query.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;org.jooq.Condition&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/metastore/rdbms/transform/MetadataMapper.html#toDeleteConditions-java.util.List-">toDeleteConditions</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/drill/metastore/rdbms/transform/MetadataMapper.html" title="type parameter in MetadataMapper">U</a>&gt;&nbsp;units)</code>
<div class="block">Since data in Metastore is deleted by partition, extracts
partitions values from given list of Metastore component metadata units
and creates list of delete conditions based on them.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;org.jooq.Field&lt;?&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/metastore/rdbms/transform/MetadataMapper.html#toFields-java.util.List-">toFields</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/drill/metastore/MetastoreColumn.html" title="enum in org.apache.drill.metastore">MetastoreColumn</a>&gt;&nbsp;columns)</code>
<div class="block">Matches given list of Metastore columns to the available
RDBMS table columns.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/drill/metastore/rdbms/transform/MetadataMapper.html" title="type parameter in MetadataMapper">R</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/metastore/rdbms/transform/MetadataMapper.html#toRecord-U-">toRecord</a></span>(<a href="../../../../../../org/apache/drill/metastore/rdbms/transform/MetadataMapper.html" title="type parameter in MetadataMapper">U</a>&nbsp;unit)</code>
<div class="block">Converts Metastore component metadata unit into RDBMS table record.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/drill/metastore/rdbms/transform/MetadataMapper.html" title="type parameter in MetadataMapper">U</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/metastore/rdbms/transform/MetadataMapper.html#toUnit-org.jooq.Record-">toUnit</a></span>(org.jooq.Record&nbsp;record)</code>
<div class="block">Converts RDBMS table record into Metastore component metadata unit.</div>
</td>
</tr>
</table>
</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="table--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>table</h4>
<pre>org.jooq.Table&lt;<a href="../../../../../../org/apache/drill/metastore/rdbms/transform/MetadataMapper.html" title="type parameter in MetadataMapper">R</a>&gt;&nbsp;table()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>RDBMS table instance</dd>
</dl>
</li>
</ul>
<a name="emptyUnit--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>emptyUnit</h4>
<pre><a href="../../../../../../org/apache/drill/metastore/rdbms/transform/MetadataMapper.html" title="type parameter in MetadataMapper">U</a>&nbsp;emptyUnit()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Metastore component metadata unit instance with all fields set to null</dd>
</dl>
</li>
</ul>
<a name="toUnit-org.jooq.Record-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toUnit</h4>
<pre><a href="../../../../../../org/apache/drill/metastore/rdbms/transform/MetadataMapper.html" title="type parameter in MetadataMapper">U</a>&nbsp;toUnit(org.jooq.Record&nbsp;record)</pre>
<div class="block">Converts RDBMS table record into Metastore component metadata unit.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>record</code> - RDBMS table record</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Metastore component metadata unit instance</dd>
</dl>
</li>
</ul>
<a name="toRecord-java.lang.Object-">
<!-- -->
</a><a name="toRecord-U-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toRecord</h4>
<pre><a href="../../../../../../org/apache/drill/metastore/rdbms/transform/MetadataMapper.html" title="type parameter in MetadataMapper">R</a>&nbsp;toRecord(<a href="../../../../../../org/apache/drill/metastore/rdbms/transform/MetadataMapper.html" title="type parameter in MetadataMapper">U</a>&nbsp;unit)</pre>
<div class="block">Converts Metastore component metadata unit into RDBMS table record.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>unit</code> - Metastore component metadata unit</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>RDBMS table record instance</dd>
</dl>
</li>
</ul>
<a name="toFields-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toFields</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;org.jooq.Field&lt;?&gt;&gt;&nbsp;toFields(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/drill/metastore/MetastoreColumn.html" title="enum in org.apache.drill.metastore">MetastoreColumn</a>&gt;&nbsp;columns)</pre>
<div class="block">Matches given list of Metastore columns to the available
RDBMS table columns.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>columns</code> - list of Metastore columns</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>list of RDBMS table fields</dd>
</dl>
</li>
</ul>
<a name="toCondition-org.apache.drill.metastore.expressions.FilterExpression-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toCondition</h4>
<pre>org.jooq.Condition&nbsp;toCondition(<a href="../../../../../../org/apache/drill/metastore/expressions/FilterExpression.html" title="interface in org.apache.drill.metastore.expressions">FilterExpression</a>&nbsp;filter)</pre>
<div class="block">Converts Metastore filter expression into JOOQ condition instance
which will be used as where clause in SQL query.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>filter</code> - filter expression</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>JOOQ condition instance</dd>
</dl>
</li>
</ul>
<a name="toDeleteConditions-java.util.List-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toDeleteConditions</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;org.jooq.Condition&gt;&nbsp;toDeleteConditions(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../../../org/apache/drill/metastore/rdbms/transform/MetadataMapper.html" title="type parameter in MetadataMapper">U</a>&gt;&nbsp;units)</pre>
<div class="block">Since data in Metastore is deleted by partition, extracts
partitions values from given list of Metastore component metadata units
and creates list of delete conditions based on them.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>units</code> - list of Metastore component metadata units</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>list of JOOQ condition instances</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="class-use/MetadataMapper.html">Use</a></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/drill/metastore/rdbms/transform/AbstractTransformer.html" title="class in org.apache.drill.metastore.rdbms.transform"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/drill/metastore/rdbms/transform/RdbmsFilterExpressionVisitor.html" title="class in org.apache.drill.metastore.rdbms.transform"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/drill/metastore/rdbms/transform/MetadataMapper.html" target="_top">Frames</a></li>
<li><a href="MetadataMapper.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 1970 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>