blob: e99256f784589cd1ae14339c331062948f088ee6 [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>org.apache.drill.exec.store.sys (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="org.apache.drill.exec.store.sys (Drill : 1.20.3 API)";
}
}
catch(err) {
}
//-->
</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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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/exec/store/spss/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../org/apache/drill/exec/store/sys/store/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/drill/exec/store/sys/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.drill.exec.store.sys</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/sys/PersistentStore.html" title="interface in org.apache.drill.exec.store.sys">PersistentStore</a>&lt;V&gt;</td>
<td class="colLast">
<div class="block">Stores and retrieve instances of given value type.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/sys/PersistentStoreProvider.html" title="interface in org.apache.drill.exec.store.sys">PersistentStoreProvider</a></td>
<td class="colLast">
<div class="block">A factory used to create <a href="../../../../../../org/apache/drill/exec/store/sys/PersistentStore.html" title="interface in org.apache.drill.exec.store.sys"><code>store</code></a> instances.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/sys/Store.html" title="interface in org.apache.drill.exec.store.sys">Store</a>&lt;V&gt;</td>
<td class="colLast">
<div class="block">A Store interface used to store and retrieve instances of given value type.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/sys/VersionedPersistentStore.html" title="interface in org.apache.drill.exec.store.sys">VersionedPersistentStore</a>&lt;V&gt;</td>
<td class="colLast">
<div class="block">Extension to the Store interface that supports versions</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/sys/AliasesIterator.html" title="class in org.apache.drill.exec.store.sys">AliasesIterator</a></td>
<td class="colLast">
<div class="block">List aliases as a System Table</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/sys/AliasesIterator.AliasInfo.html" title="class in org.apache.drill.exec.store.sys">AliasesIterator.AliasInfo</a></td>
<td class="colLast">
<div class="block">Representation of an entry in the System table - Aliases</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/sys/BasePersistentStore.html" title="class in org.apache.drill.exec.store.sys">BasePersistentStore</a>&lt;V&gt;</td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/sys/BitToUserConnectionIterator.html" title="class in org.apache.drill.exec.store.sys">BitToUserConnectionIterator</a></td>
<td class="colLast">
<div class="block">Add a system table for listing connected users on a cluster</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/sys/BitToUserConnectionIterator.ConnectionInfo.html" title="class in org.apache.drill.exec.store.sys">BitToUserConnectionIterator.ConnectionInfo</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/sys/CaseInsensitivePersistentStore.html" title="class in org.apache.drill.exec.store.sys">CaseInsensitivePersistentStore</a>&lt;V&gt;</td>
<td class="colLast">
<div class="block">Wrapper around <a href="../../../../../../org/apache/drill/exec/store/sys/PersistentStore.html" title="interface in org.apache.drill.exec.store.sys"><code>PersistentStore</code></a> to ensure all passed keys are
converted to lower case and stored this way.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/sys/DrillbitIterator.html" title="class in org.apache.drill.exec.store.sys">DrillbitIterator</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/sys/DrillbitIterator.DrillbitInstance.html" title="class in org.apache.drill.exec.store.sys">DrillbitIterator.DrillbitInstance</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/sys/ExtendedOptionIterator.html" title="class in org.apache.drill.exec.store.sys">ExtendedOptionIterator</a></td>
<td class="colLast">
<div class="block">Extends the original Option iterator.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/sys/ExtendedOptionIterator.ExtendedOptionValueWrapper.html" title="class in org.apache.drill.exec.store.sys">ExtendedOptionIterator.ExtendedOptionValueWrapper</a></td>
<td class="colLast">
<div class="block">Wrapper class for Extended Option Value</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/sys/FunctionsIterator.html" title="class in org.apache.drill.exec.store.sys">FunctionsIterator</a></td>
<td class="colLast">
<div class="block">List functions as a System Table</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/sys/FunctionsIterator.FunctionInfo.html" title="class in org.apache.drill.exec.store.sys">FunctionsIterator.FunctionInfo</a></td>
<td class="colLast">
<div class="block">Representation of an entry in the System table - Functions</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/sys/MemoryIterator.html" title="class in org.apache.drill.exec.store.sys">MemoryIterator</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/sys/MemoryIterator.MemoryInfo.html" title="class in org.apache.drill.exec.store.sys">MemoryIterator.MemoryInfo</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/sys/OptionIterator.html" title="class in org.apache.drill.exec.store.sys">OptionIterator</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/sys/OptionIterator.OptionValueWrapper.html" title="class in org.apache.drill.exec.store.sys">OptionIterator.OptionValueWrapper</a></td>
<td class="colLast">
<div class="block">Wrapper class for OptionValue to add Status</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/sys/PersistentStoreConfig.html" title="class in org.apache.drill.exec.store.sys">PersistentStoreConfig</a>&lt;V&gt;</td>
<td class="colLast">
<div class="block">An abstraction for configurations that are used to create a <a href="../../../../../../org/apache/drill/exec/store/sys/PersistentStore.html" title="interface in org.apache.drill.exec.store.sys"><code>store</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/sys/PersistentStoreConfig.StoreConfigBuilder.html" title="class in org.apache.drill.exec.store.sys">PersistentStoreConfig.StoreConfigBuilder</a>&lt;V&gt;</td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/sys/PersistentStoreRegistry.html" title="class in org.apache.drill.exec.store.sys">PersistentStoreRegistry</a>&lt;C extends <a href="../../../../../../org/apache/drill/exec/coord/ClusterCoordinator.html" title="class in org.apache.drill.exec.coord">ClusterCoordinator</a>&gt;</td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/sys/ProfileInfoIterator.html" title="class in org.apache.drill.exec.store.sys">ProfileInfoIterator</a></td>
<td class="colLast">
<div class="block">System table listing completed profiles</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/sys/ProfileInfoIterator.ProfileInfo.html" title="class in org.apache.drill.exec.store.sys">ProfileInfoIterator.ProfileInfo</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/sys/ProfileIterator.html" title="class in org.apache.drill.exec.store.sys">ProfileIterator</a></td>
<td class="colLast">
<div class="block">Base class for Profile Iterators</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/sys/ProfileJsonIterator.html" title="class in org.apache.drill.exec.store.sys">ProfileJsonIterator</a></td>
<td class="colLast">
<div class="block">System table listing completed profiles as JSON documents</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/sys/ProfileJsonIterator.ProfileJson.html" title="class in org.apache.drill.exec.store.sys">ProfileJsonIterator.ProfileJson</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/sys/StaticDrillTable.html" title="class in org.apache.drill.exec.store.sys">StaticDrillTable</a></td>
<td class="colLast">
<div class="block">A <a href="../../../../../../org/apache/drill/exec/planner/logical/DrillTable.html" title="class in org.apache.drill.exec.planner.logical"><code>DrillTable</code></a> with a defined schema
Currently, this is a wrapper class for <a href="../../../../../../org/apache/drill/exec/store/sys/SystemTable.html" title="enum in org.apache.drill.exec.store.sys"><code>SystemTable</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/sys/SystemTableBatchCreator.html" title="class in org.apache.drill.exec.store.sys">SystemTableBatchCreator</a></td>
<td class="colLast">
<div class="block">This class creates batches based on the the type of <a href="../../../../../../org/apache/drill/exec/store/sys/SystemTable.html" title="enum in org.apache.drill.exec.store.sys"><code>SystemTable</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/sys/SystemTablePlugin.html" title="class in org.apache.drill.exec.store.sys">SystemTablePlugin</a></td>
<td class="colLast">
<div class="block">A "storage" plugin for system tables.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/sys/SystemTablePluginConfig.html" title="class in org.apache.drill.exec.store.sys">SystemTablePluginConfig</a></td>
<td class="colLast">
<div class="block">A namesake plugin configuration for system tables.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/sys/SystemTableScan.html" title="class in org.apache.drill.exec.store.sys">SystemTableScan</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/sys/ThreadsIterator.html" title="class in org.apache.drill.exec.store.sys">ThreadsIterator</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/sys/ThreadsIterator.ThreadsInfo.html" title="class in org.apache.drill.exec.store.sys">ThreadsIterator.ThreadsInfo</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/sys/VersionIterator.html" title="class in org.apache.drill.exec.store.sys">VersionIterator</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/sys/VersionIterator.VersionInfo.html" title="class in org.apache.drill.exec.store.sys">VersionIterator.VersionInfo</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/sys/ExtendedOptionIterator.Status.html" title="enum in org.apache.drill.exec.store.sys">ExtendedOptionIterator.Status</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/sys/OptionIterator.Status.html" title="enum in org.apache.drill.exec.store.sys">OptionIterator.Status</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/sys/PersistentStoreMode.html" title="enum in org.apache.drill.exec.store.sys">PersistentStoreMode</a></td>
<td class="colLast">
<div class="block">Defines operation mode of a <a href="../../../../../../org/apache/drill/exec/store/sys/PersistentStore.html" title="interface in org.apache.drill.exec.store.sys"><code>PersistentStore</code></a> instance.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../org/apache/drill/exec/store/sys/SystemTable.html" title="enum in org.apache.drill.exec.store.sys">SystemTable</a></td>
<td class="colLast">
<div class="block">An enumeration of all tables in Drill's system ("sys") schema.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
<!-- ======= 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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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/exec/store/spss/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../../org/apache/drill/exec/store/sys/store/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/drill/exec/store/sys/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<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>