blob: 90af1ee9adebab4edfcf5a20ee3bf1a5d204e05d [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>org.apache.calcite.adapter.os (Apache Calcite API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="org.apache.calcite.adapter.os (Apache Calcite API)";
}
}
catch(err) {
}
//-->
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.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" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<main role="main">
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.calcite.adapter.os</h1>
</div>
<div class="contentContainer">
<section role="region"><a id="package.description">
<!-- -->
</a>
<div class="block">The OS adapter contains various table functions that let you query data
sources in your operating system and environment.</div>
</section>
<ul class="blockList">
<li class="blockList">
<table class="typeSummary">
<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">
<th class="colFirst" scope="row"><a href="DuTableFunction.html" title="class in org.apache.calcite.adapter.os">DuTableFunction</a></th>
<td class="colLast">
<div class="block">Table function that executes the OS "du" ("disk usage") command
to compute file sizes.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="FilesTableFunction.html" title="class in org.apache.calcite.adapter.os">FilesTableFunction</a></th>
<td class="colLast">
<div class="block">Table function that executes the OS "find" command to find files under a
particular path.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="GitCommitsTableFunction.html" title="class in org.apache.calcite.adapter.os">GitCommitsTableFunction</a></th>
<td class="colLast">
<div class="block">Table function that executes the OS "git log" command
to discover git commits.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="JpsTableFunction.html" title="class in org.apache.calcite.adapter.os">JpsTableFunction</a></th>
<td class="colLast">
<div class="block">Table function that executes the OS "jps" ("Java Virtual Machine Process
Status Tool") command to list all java processes of a user.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Processes.html" title="class in org.apache.calcite.adapter.os">Processes</a></th>
<td class="colLast">
<div class="block">Utilities regarding operating system processes.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Processes.ProcessFactory.html" title="class in org.apache.calcite.adapter.os">Processes.ProcessFactory</a></th>
<td class="colLast">
<div class="block">Creates processes.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Processes.ProcessLinesEnumerator.html" title="class in org.apache.calcite.adapter.os">Processes.ProcessLinesEnumerator</a></th>
<td class="colLast">
<div class="block">Enumerator that executes a process and returns each line as an element.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Processes.SeparatedLinesEnumerable.html" title="class in org.apache.calcite.adapter.os">Processes.SeparatedLinesEnumerable</a></th>
<td class="colLast">
<div class="block">Enumerator that executes a process and returns each line as an element.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="PsTableFunction.html" title="class in org.apache.calcite.adapter.os">PsTableFunction</a></th>
<td class="colLast">
<div class="block">Table function that executes the OS "ps" command
to list processes.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="SqlShell.html" title="class in org.apache.calcite.adapter.os">SqlShell</a></th>
<td class="colLast">
<div class="block">Command that executes its arguments as a SQL query
against Calcite's OS adapter.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="StdinTableFunction.html" title="class in org.apache.calcite.adapter.os">StdinTableFunction</a></th>
<td class="colLast">
<div class="block">Table function that reads stdin and returns one row per line.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="VmstatTableFunction.html" title="class in org.apache.calcite.adapter.os">VmstatTableFunction</a></th>
<td class="colLast">
<div class="block">Table function that executes the OS "vmstat" command
to share memory statistics.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary">
<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">
<th class="colFirst" scope="row"><a href="SqlShell.Format.html" title="enum in org.apache.calcite.adapter.os">SqlShell.Format</a></th>
<td class="colLast">
<div class="block">Output format.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
</main>
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.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" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2012&#x2013;2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>