Google Git
Sign in
apache / drill-site / 1afc0c0bd77668c5c5c8527776fb56bf6159badb / . / apidocs / org / apache / drill / metastore / rdbms / operate / RdbmsModify.html
blob: 3285f72773840eadd1ce005f20b4554205f16953 [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>RdbmsModify (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="RdbmsModify (Drill : 1.20.3 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance 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="class-use/RdbmsModify.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/operate/RdbmsMetadata.html" title="class in org.apache.drill.metastore.rdbms.operate"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/drill/metastore/rdbms/operate/RdbmsOperation.html" title="interface in org.apache.drill.metastore.rdbms.operate"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/drill/metastore/rdbms/operate/RdbmsModify.html" target="_top">Frames</a></li>
<li><a href="RdbmsModify.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><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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.operate</div>
<h2 title="Class RdbmsModify" class="title">Class RdbmsModify&lt;T&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../org/apache/drill/metastore/operate/AbstractModify.html" title="class in org.apache.drill.metastore.operate">org.apache.drill.metastore.operate.AbstractModify</a>&lt;T&gt;</li>
<li>
<ul class="inheritance">
<li>org.apache.drill.metastore.rdbms.operate.RdbmsModify&lt;T&gt;</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - Metastore component unit type</dd>
</dl>
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../../org/apache/drill/metastore/operate/Modify.html" title="interface in org.apache.drill.metastore.operate">Modify</a>&lt;T&gt;</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">RdbmsModify&lt;T&gt;</span>
extends <a href="../../../../../../org/apache/drill/metastore/operate/AbstractModify.html" title="class in org.apache.drill.metastore.operate">AbstractModify</a>&lt;T&gt;</pre>
<div class="block">Implementation of <a href="../../../../../../org/apache/drill/metastore/operate/Modify.html" title="interface in org.apache.drill.metastore.operate"><code>Modify</code></a> interface based on <a href="../../../../../../org/apache/drill/metastore/operate/AbstractModify.html" title="class in org.apache.drill.metastore.operate"><code>AbstractModify</code></a> parent class.
Modifies information in RDBMS tables based on given overwrite or delete operations.
Executes given operations in one transaction.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== 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">&nbsp;</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/drill/metastore/rdbms/operate/RdbmsModify.html#RdbmsModify-org.apache.drill.metastore.operate.MetadataTypeValidator-org.apache.drill.metastore.rdbms.RdbmsMetastoreContext-">RdbmsModify</a></span>(<a href="../../../../../../org/apache/drill/metastore/operate/MetadataTypeValidator.html" title="interface in org.apache.drill.metastore.operate">MetadataTypeValidator</a>&nbsp;metadataTypeValidator,
<a href="../../../../../../org/apache/drill/metastore/rdbms/RdbmsMetastoreContext.html" title="interface in org.apache.drill.metastore.rdbms">RdbmsMetastoreContext</a>&lt;<a href="../../../../../../org/apache/drill/metastore/rdbms/operate/RdbmsModify.html" title="type parameter in RdbmsModify">T</a>&gt;&nbsp;context)</code>&nbsp;</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">&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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/metastore/rdbms/operate/RdbmsModify.html#addDelete-org.apache.drill.metastore.operate.Delete-">addDelete</a></span>(<a href="../../../../../../org/apache/drill/metastore/operate/Delete.html" title="class in org.apache.drill.metastore.operate">Delete</a>&nbsp;delete)</code>
<div class="block">Adds delete operation to the list of pending operations.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/metastore/rdbms/operate/RdbmsModify.html#addOverwrite-java.util.List-">addOverwrite</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/operate/RdbmsModify.html" title="type parameter in RdbmsModify">T</a>&gt;&nbsp;units)</code>
<div class="block">Adds overwrite operation to the list of pending operations.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/metastore/rdbms/operate/RdbmsModify.html#execute--">execute</a></span>()</code>
<div class="block">Executes list of provided metastore operations in one transaction if Metastore implementation
supports transactions, otherwise executes operations consecutively.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/drill/metastore/rdbms/operate/RdbmsModify.html#purge--">purge</a></span>()</code>
<div class="block">Deletes all data from the Metastore component.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.drill.metastore.operate.AbstractModify">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.drill.metastore.operate.<a href="../../../../../../org/apache/drill/metastore/operate/AbstractModify.html" title="class in org.apache.drill.metastore.operate">AbstractModify</a></h3>
<code><a href="../../../../../../org/apache/drill/metastore/operate/AbstractModify.html#delete-org.apache.drill.metastore.operate.Delete-">delete</a>, <a href="../../../../../../org/apache/drill/metastore/operate/AbstractModify.html#overwrite-java.util.List-">overwrite</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.drill.metastore.operate.Modify">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.drill.metastore.operate.<a href="../../../../../../org/apache/drill/metastore/operate/Modify.html" title="interface in org.apache.drill.metastore.operate">Modify</a></h3>
<code><a href="../../../../../../org/apache/drill/metastore/operate/Modify.html#overwrite-T...-">overwrite</a></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="RdbmsModify-org.apache.drill.metastore.operate.MetadataTypeValidator-org.apache.drill.metastore.rdbms.RdbmsMetastoreContext-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>RdbmsModify</h4>
<pre>public&nbsp;RdbmsModify(<a href="../../../../../../org/apache/drill/metastore/operate/MetadataTypeValidator.html" title="interface in org.apache.drill.metastore.operate">MetadataTypeValidator</a>&nbsp;metadataTypeValidator,
<a href="../../../../../../org/apache/drill/metastore/rdbms/RdbmsMetastoreContext.html" title="interface in org.apache.drill.metastore.rdbms">RdbmsMetastoreContext</a>&lt;<a href="../../../../../../org/apache/drill/metastore/rdbms/operate/RdbmsModify.html" title="type parameter in RdbmsModify">T</a>&gt;&nbsp;context)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="execute--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>execute</h4>
<pre>public&nbsp;void&nbsp;execute()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/drill/metastore/operate/Modify.html#execute--">Modify</a></code></span></div>
<div class="block">Executes list of provided metastore operations in one transaction if Metastore implementation
supports transactions, otherwise executes operations consecutively.
All operations should be executed in the same order as they were added.</div>
</li>
</ul>
<a name="purge--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>purge</h4>
<pre>public&nbsp;void&nbsp;purge()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/drill/metastore/operate/Modify.html#purge--">Modify</a></code></span></div>
<div class="block">Deletes all data from the Metastore component.
Note, this is terminal operation and it does not take into account
any previously set delete operations or overwrite units,
it just deletes all data.</div>
</li>
</ul>
<a name="addOverwrite-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addOverwrite</h4>
<pre>protected&nbsp;void&nbsp;addOverwrite(<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/operate/RdbmsModify.html" title="type parameter in RdbmsModify">T</a>&gt;&nbsp;units)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../../org/apache/drill/metastore/operate/AbstractModify.html#addOverwrite-java.util.List-">AbstractModify</a></code></span></div>
<div class="block">Adds overwrite operation to the list of pending operations.
Is used to ensure operations execution order.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/drill/metastore/operate/AbstractModify.html#addOverwrite-java.util.List-">addOverwrite</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/drill/metastore/operate/AbstractModify.html" title="class in org.apache.drill.metastore.operate">AbstractModify</a>&lt;<a href="../../../../../../org/apache/drill/metastore/rdbms/operate/RdbmsModify.html" title="type parameter in RdbmsModify">T</a>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>units</code> - list of Metastore metadata units</dd>
</dl>
</li>
</ul>
<a name="addDelete-org.apache.drill.metastore.operate.Delete-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>addDelete</h4>
<pre>protected&nbsp;void&nbsp;addDelete(<a href="../../../../../../org/apache/drill/metastore/operate/Delete.html" title="class in org.apache.drill.metastore.operate">Delete</a>&nbsp;delete)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../../org/apache/drill/metastore/operate/AbstractModify.html#addDelete-org.apache.drill.metastore.operate.Delete-">AbstractModify</a></code></span></div>
<div class="block">Adds delete operation to the list of pending operations.
Is used to ensure operations execution order.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/drill/metastore/operate/AbstractModify.html#addDelete-org.apache.drill.metastore.operate.Delete-">addDelete</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/drill/metastore/operate/AbstractModify.html" title="class in org.apache.drill.metastore.operate">AbstractModify</a>&lt;<a href="../../../../../../org/apache/drill/metastore/rdbms/operate/RdbmsModify.html" title="type parameter in RdbmsModify">T</a>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>delete</code> - Metastore delete operation holder</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/RdbmsModify.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/operate/RdbmsMetadata.html" title="class in org.apache.drill.metastore.rdbms.operate"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../org/apache/drill/metastore/rdbms/operate/RdbmsOperation.html" title="interface in org.apache.drill.metastore.rdbms.operate"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/drill/metastore/rdbms/operate/RdbmsModify.html" target="_top">Frames</a></li>
<li><a href="RdbmsModify.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><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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>