blob: bf0ad0e2fefa108165e997dfaf084dd24e636bae [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>org.apache.calcite.piglet (Apache Calcite API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: package: org.apache.calcite.piglet">
<meta name="generator" content="javadoc/PackageWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="package-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<div class="about-language"><b>Apache Calcite</b></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li class="nav-bar-cell1-rev">Package</li>
<li>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#package">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Package:&nbsp;</li>
<li><a href="#package-description">Description</a>&nbsp;|&nbsp;</li>
<li><a href="#related-package-summary">Related Packages</a>&nbsp;|&nbsp;</li>
<li><a href="#class-summary">Classes and Interfaces</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<div class="header">
<h1 title="Package org.apache.calcite.piglet" class="title">Package org.apache.calcite.piglet</h1>
</div>
<hr>
<div class="package-signature">package <span class="element-name">org.apache.calcite.piglet</span></div>
<section class="package-description" id="package-description">
<div class="block">Piglet, a Pig-like language.</div>
</section>
<section class="summary">
<ul class="summary-list">
<li>
<div id="related-package-summary">
<div class="caption"><span>Related Packages</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Package</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="../package-summary.html">org.apache.calcite</a></div>
<div class="col-last even-row-color">
<div class="block">Main package for Calcite, the dynamic data management platform.</div>
</div>
</div>
</div>
</li>
<li>
<div id="class-summary">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab1" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab1', 2)" class="table-tab">Interfaces</button><button id="class-summary-tab2" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab2', 2)" class="table-tab">Classes</button><button id="class-summary-tab3" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab3', 2)" class="table-tab">Enums</button></div>
<div id="class-summary.tabpanel" role="tabpanel">
<div class="summary-table two-column-summary" aria-labelledby="class-summary-tab0">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Ast.html" title="class in org.apache.calcite.piglet">Ast</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Abstract syntax tree.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Ast.Assignment.html" title="class in org.apache.calcite.piglet">Ast.Assignment</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Abstract base class for statements that assign to a named relation.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Ast.Assignment1.html" title="class in org.apache.calcite.piglet">Ast.Assignment1</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Abstract base class for an assignment with one source relation.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Ast.BagType.html" title="class in org.apache.calcite.piglet">Ast.BagType</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Parse tree for a bag type.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Ast.Call.html" title="class in org.apache.calcite.piglet">Ast.Call</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Parse tree node for a call to a function or operator.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Ast.DescribeStmt.html" title="class in org.apache.calcite.piglet">Ast.DescribeStmt</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Parse tree node for DESCRIBE statement.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab3"><a href="Ast.Direction.html" title="enum in org.apache.calcite.piglet">Ast.Direction</a></div>
<div class="col-last even-row-color class-summary class-summary-tab3">
<div class="block">Sort direction.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Ast.DistinctStmt.html" title="class in org.apache.calcite.piglet">Ast.DistinctStmt</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Parse tree node for DISTINCT statement.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Ast.DumpStmt.html" title="class in org.apache.calcite.piglet">Ast.DumpStmt</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Parse tree node for DUMP statement.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Ast.FieldSchema.html" title="class in org.apache.calcite.piglet">Ast.FieldSchema</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Parse tree for field schema.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Ast.FilterStmt.html" title="class in org.apache.calcite.piglet">Ast.FilterStmt</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Parse tree node for FILTER statement.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Ast.ForeachNestedStmt.html" title="class in org.apache.calcite.piglet">Ast.ForeachNestedStmt</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Parse tree node for FOREACH statement (nested).</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Ast.ForeachStmt.html" title="class in org.apache.calcite.piglet">Ast.ForeachStmt</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Parse tree node for FOREACH statement (non-nested).</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Ast.GroupStmt.html" title="class in org.apache.calcite.piglet">Ast.GroupStmt</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Parse tree node for GROUP statement.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Ast.Identifier.html" title="class in org.apache.calcite.piglet">Ast.Identifier</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Parse tree node for Identifier.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Ast.LimitStmt.html" title="class in org.apache.calcite.piglet">Ast.LimitStmt</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Parse tree node for LIMIT statement.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Ast.Literal.html" title="class in org.apache.calcite.piglet">Ast.Literal</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Parse tree node for Literal.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Ast.LoadStmt.html" title="class in org.apache.calcite.piglet">Ast.LoadStmt</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Parse tree node for LOAD statement.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Ast.MapType.html" title="class in org.apache.calcite.piglet">Ast.MapType</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Parse tree for a map type.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Ast.Node.html" title="class in org.apache.calcite.piglet">Ast.Node</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Abstract base class for parse tree node.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Ast.NumericLiteral.html" title="class in org.apache.calcite.piglet">Ast.NumericLiteral</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Parse tree node for NumericLiteral.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab3"><a href="Ast.Op.html" title="enum in org.apache.calcite.piglet">Ast.Op</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab3">
<div class="block">Parse tree node type.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Ast.OrderStmt.html" title="class in org.apache.calcite.piglet">Ast.OrderStmt</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Parse tree node for ORDER statement.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Ast.Program.html" title="class in org.apache.calcite.piglet">Ast.Program</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Parse tree node for a program.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Ast.ScalarType.html" title="class in org.apache.calcite.piglet">Ast.ScalarType</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Parse tree for scalar type such as <code>int</code>.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Ast.Schema.html" title="class in org.apache.calcite.piglet">Ast.Schema</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Parse tree for schema.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Ast.SpecialIdentifier.html" title="class in org.apache.calcite.piglet">Ast.SpecialIdentifier</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Parse tree node for "*", a special kind of identifier.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Ast.Stmt.html" title="class in org.apache.calcite.piglet">Ast.Stmt</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Abstract base class for parse tree node representing a statement.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Ast.TupleType.html" title="class in org.apache.calcite.piglet">Ast.TupleType</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Parse tree for a tuple type.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Ast.Type.html" title="class in org.apache.calcite.piglet">Ast.Type</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Parse tree for type.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Ast.ValuesStmt.html" title="class in org.apache.calcite.piglet">Ast.ValuesStmt</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Parse tree node for VALUES statement.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DynamicTupleRecordType.html" title="class in org.apache.calcite.piglet">DynamicTupleRecordType</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Represents Pig Tuples with unknown fields.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Handler.html" title="class in org.apache.calcite.piglet">Handler</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Walks over a Piglet AST and calls the corresponding methods in a
<a href="../tools/PigRelBuilder.html" title="class in org.apache.calcite.tools"><code>PigRelBuilder</code></a>.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="PigConverter.html" title="class in org.apache.calcite.piglet">PigConverter</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Extension from PigServer to convert Pig scripts into logical relational
algebra plans and SQL statements.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="PigRelBuilder.html" title="class in org.apache.calcite.piglet">PigRelBuilder</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Extension to <a href="../tools/RelBuilder.html" title="class in org.apache.calcite.tools"><code>RelBuilder</code></a> for Pig logical operators.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="PigRelBuilder.PigRelTranslationContext.html" title="class in org.apache.calcite.piglet">PigRelBuilder.PigRelTranslationContext</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Context constructed during Pig-to-<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel"><code>RelNode</code></a> translation process.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="PigRelSqlUdfs.html" title="class in org.apache.calcite.piglet">PigRelSqlUdfs</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">User-defined functions (<a href="../sql/validate/SqlUserDefinedFunction.html" title="class in org.apache.calcite.sql.validate"><code>UDFs</code></a>)
needed for Pig-to-<a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel"><code>RelNode</code></a> translation.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="PigRelToSqlConverter.html" title="class in org.apache.calcite.piglet">PigRelToSqlConverter</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">An extension of <a href="../rel/rel2sql/RelToSqlConverter.html" title="class in org.apache.calcite.rel.rel2sql"><code>RelToSqlConverter</code></a> to convert a relation algebra tree,
translated from a Pig script, into a SQL statement.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="PigTable.html" title="class in org.apache.calcite.piglet">PigTable</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">A non-queriable table that contains only row type to represent a Pig Table.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="PigToSqlAggregateRule.html" title="class in org.apache.calcite.piglet">PigToSqlAggregateRule</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Planner rule that converts Pig aggregate UDF calls to built-in SQL
aggregates.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="PigToSqlAggregateRule.Config.html" title="interface in org.apache.calcite.piglet">PigToSqlAggregateRule.Config</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">Rule configuration.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="PigUdfs.html" title="class in org.apache.calcite.piglet">PigUdfs</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Implementation methods.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="PigUserDefinedFunction.html" title="class in org.apache.calcite.piglet">PigUserDefinedFunction</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Pig user-defined function.</div>
</div>
</div>
</div>
</div>
</li>
</ul>
</section>
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &copy; 2012-2023 Apache Software Foundation. All Rights Reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>