blob: 1a81ad0725c8338c962ca91de8cdd02c86c5a908 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>org.apache.calcite.materialize (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.materialize (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.materialize</h1>
</div>
<div class="contentContainer">
<section role="region"><a id="package.description">
<!-- -->
</a>
<div class="block">Management of materialized query results.
<p>An actor (<a href="MaterializationActor.html" title="class in org.apache.calcite.materialize"><code>MaterializationActor</code></a>)
maintains the state of all
materializations in the system and is wrapped in a service
(<a href="MaterializationService.html" title="class in org.apache.calcite.materialize"><code>MaterializationService</code></a>)
for access from other parts of the system.</p>
<p>Optimizer rules allow Calcite to rewrite queries using materializations,
if they are valid (that is, contain the same result as executing their
defining query) and lower cost.
<p>In future, the actor may manage the process of updating materializations,
instantiating materializations from the intermediate results of queries, and
recognize what materializations would be useful based on actual query load.</div>
</section>
<ul class="blockList">
<li class="blockList">
<table class="typeSummary">
<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">
<th class="colFirst" scope="row"><a href="LatticeStatisticProvider.html" title="interface in org.apache.calcite.materialize">LatticeStatisticProvider</a></th>
<td class="colLast">
<div class="block">Estimates row counts for a lattice and its attributes.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="LatticeStatisticProvider.Factory.html" title="interface in org.apache.calcite.materialize">LatticeStatisticProvider.Factory</a></th>
<td class="colLast">
<div class="block">Creates a <a href="LatticeStatisticProvider.html" title="interface in org.apache.calcite.materialize"><code>LatticeStatisticProvider</code></a> for a given
<a href="Lattice.html" title="class in org.apache.calcite.materialize"><code>Lattice</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="MaterializationService.TableFactory.html" title="interface in org.apache.calcite.materialize">MaterializationService.TableFactory</a></th>
<td class="colLast">
<div class="block">Creates tables that represent a materialized view.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="SqlStatisticProvider.html" title="interface in org.apache.calcite.materialize">SqlStatisticProvider</a></th>
<td class="colLast">
<div class="block">Estimates row counts for tables and columns, and whether combinations of
columns form primary/unique and foreign keys.</div>
</td>
</tr>
</tbody>
</table>
</li>
<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="CachingLatticeStatisticProvider.html" title="class in org.apache.calcite.materialize">CachingLatticeStatisticProvider</a></th>
<td class="colLast">
<div class="block">Implementation of <a href="LatticeStatisticProvider.html" title="interface in org.apache.calcite.materialize"><code>LatticeStatisticProvider</code></a> that caches single-column
statistics and computes multi-column statistics from these.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="DelegatingLatticeStatisticProvider.html" title="class in org.apache.calcite.materialize">DelegatingLatticeStatisticProvider</a></th>
<td class="colLast">
<div class="block">Implementation of <a href="LatticeStatisticProvider.html" title="interface in org.apache.calcite.materialize"><code>LatticeStatisticProvider</code></a> that delegates
to an underlying provider.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Lattice.html" title="class in org.apache.calcite.materialize">Lattice</a></th>
<td class="colLast">
<div class="block">Structure that allows materialized views based upon a star schema to be
recognized and recommended.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Lattice.BaseColumn.html" title="class in org.apache.calcite.materialize">Lattice.BaseColumn</a></th>
<td class="colLast">
<div class="block">Column in a lattice.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Lattice.Builder.html" title="class in org.apache.calcite.materialize">Lattice.Builder</a></th>
<td class="colLast">
<div class="block">Lattice builder.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Lattice.Builder.Fixer.html" title="class in org.apache.calcite.materialize">Lattice.Builder.Fixer</a></th>
<td class="colLast">
<div class="block">Work space for fixing up a tree of mutable nodes.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Lattice.Column.html" title="class in org.apache.calcite.materialize">Lattice.Column</a></th>
<td class="colLast">
<div class="block">Column in a lattice.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Lattice.DerivedColumn.html" title="class in org.apache.calcite.materialize">Lattice.DerivedColumn</a></th>
<td class="colLast">
<div class="block">Column in a lattice that is based upon a SQL expression.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Lattice.Edge.html" title="class in org.apache.calcite.materialize">Lattice.Edge</a></th>
<td class="colLast">
<div class="block">Edge in the temporary graph.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Lattice.Measure.html" title="class in org.apache.calcite.materialize">Lattice.Measure</a></th>
<td class="colLast">
<div class="block">A measure within a <a href="Lattice.html" title="class in org.apache.calcite.materialize"><code>Lattice</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Lattice.SqlWriter.html" title="class in org.apache.calcite.materialize">Lattice.SqlWriter</a></th>
<td class="colLast">
<div class="block">The information necessary to convert a column to SQL.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Lattice.Tile.html" title="class in org.apache.calcite.materialize">Lattice.Tile</a></th>
<td class="colLast">
<div class="block">Materialized aggregate within a lattice.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Lattice.TileBuilder.html" title="class in org.apache.calcite.materialize">Lattice.TileBuilder</a></th>
<td class="colLast">
<div class="block">Tile builder.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Lattice.Vertex.html" title="class in org.apache.calcite.materialize">Lattice.Vertex</a></th>
<td class="colLast">
<div class="block">Vertex in the temporary graph.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="LatticeChildNode.html" title="class in org.apache.calcite.materialize">LatticeChildNode</a></th>
<td class="colLast">
<div class="block">Non-root node in a <a href="Lattice.html" title="class in org.apache.calcite.materialize"><code>Lattice</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="LatticeNode.html" title="class in org.apache.calcite.materialize">LatticeNode</a></th>
<td class="colLast">
<div class="block">Source relation of a lattice.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="LatticeRootNode.html" title="class in org.apache.calcite.materialize">LatticeRootNode</a></th>
<td class="colLast">
<div class="block">Root node in a <a href="Lattice.html" title="class in org.apache.calcite.materialize"><code>Lattice</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Lattices.html" title="class in org.apache.calcite.materialize">Lattices</a></th>
<td class="colLast">
<div class="block">Utilities for <a href="Lattice.html" title="class in org.apache.calcite.materialize"><code>Lattice</code></a>, <a href="LatticeStatisticProvider.html" title="interface in org.apache.calcite.materialize"><code>LatticeStatisticProvider</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="LatticeSpace.html" title="class in org.apache.calcite.materialize">LatticeSpace</a></th>
<td class="colLast">
<div class="block">Space within which lattices exist.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="LatticeSuggester.html" title="class in org.apache.calcite.materialize">LatticeSuggester</a></th>
<td class="colLast">
<div class="block">Algorithm that suggests a set of lattices.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="LatticeSuggester.BaseColRef.html" title="class in org.apache.calcite.materialize">LatticeSuggester.BaseColRef</a></th>
<td class="colLast">
<div class="block">Reference to a base column.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="LatticeSuggester.ColRef.html" title="class in org.apache.calcite.materialize">LatticeSuggester.ColRef</a></th>
<td class="colLast">
<div class="block">Column reference.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="LatticeSuggester.DerivedColRef.html" title="class in org.apache.calcite.materialize">LatticeSuggester.DerivedColRef</a></th>
<td class="colLast">
<div class="block">Reference to a derived column (that is, an expression).</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="LatticeSuggester.Frame.html" title="class in org.apache.calcite.materialize">LatticeSuggester.Frame</a></th>
<td class="colLast">
<div class="block">Information about the parent of fields from a relational expression.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="LatticeSuggester.Hop.html" title="class in org.apache.calcite.materialize">LatticeSuggester.Hop</a></th>
<td class="colLast">
<div class="block">A hop is a join condition.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="LatticeSuggester.MutableMeasure.html" title="class in org.apache.calcite.materialize">LatticeSuggester.MutableMeasure</a></th>
<td class="colLast">
<div class="block">An aggregate call.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="LatticeSuggester.Query.html" title="class in org.apache.calcite.materialize">LatticeSuggester.Query</a></th>
<td class="colLast">
<div class="block">Holds state for a particular query graph.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="LatticeSuggester.StepRef.html" title="class in org.apache.calcite.materialize">LatticeSuggester.StepRef</a></th>
<td class="colLast">
<div class="block">Use of a step within a query.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="LatticeSuggester.StepRef.Factory.html" title="class in org.apache.calcite.materialize">LatticeSuggester.StepRef.Factory</a></th>
<td class="colLast">
<div class="block">Creates <a href="LatticeSuggester.StepRef.html" title="class in org.apache.calcite.materialize"><code>LatticeSuggester.StepRef</code></a> instances.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="LatticeSuggester.TableRef.html" title="class in org.apache.calcite.materialize">LatticeSuggester.TableRef</a></th>
<td class="colLast">
<div class="block">Use of a table within a query.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="LatticeTable.html" title="class in org.apache.calcite.materialize">LatticeTable</a></th>
<td class="colLast">
<div class="block">Table registered in the graph.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="MaterializationActor.html" title="class in org.apache.calcite.materialize">MaterializationActor</a></th>
<td class="colLast">
<div class="block">Actor that manages the state of materializations in the system.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="MaterializationActor.Materialization.html" title="class in org.apache.calcite.materialize">MaterializationActor.Materialization</a></th>
<td class="colLast">
<div class="block">A query materialized in a table, so that reading from the table gives the
same results as executing the query.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="MaterializationActor.QueryKey.html" title="class in org.apache.calcite.materialize">MaterializationActor.QueryKey</a></th>
<td class="colLast">
<div class="block">A materialization can be re-used if it is the same SQL, on the same
schema, with the same path for resolving functions.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="MaterializationKey.html" title="class in org.apache.calcite.materialize">MaterializationKey</a></th>
<td class="colLast">
<div class="block">Unique identifier for a materialization.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="MaterializationService.html" title="class in org.apache.calcite.materialize">MaterializationService</a></th>
<td class="colLast">
<div class="block">Manages the collection of materialized tables known to the system,
and the process by which they become valid and invalid.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="MaterializationService.DefaultTableFactory.html" title="class in org.apache.calcite.materialize">MaterializationService.DefaultTableFactory</a></th>
<td class="colLast">
<div class="block">Default implementation of <a href="MaterializationService.TableFactory.html" title="interface in org.apache.calcite.materialize"><code>MaterializationService.TableFactory</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="MutableNode.html" title="class in org.apache.calcite.materialize">MutableNode</a></th>
<td class="colLast">
<div class="block">Mutable version of <a href="LatticeNode.html" title="class in org.apache.calcite.materialize"><code>LatticeNode</code></a>, used while a graph is being
built.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Path.html" title="class in org.apache.calcite.materialize">Path</a></th>
<td class="colLast">
<div class="block">A sequence of <a href="Step.html" title="class in org.apache.calcite.materialize"><code>Step</code></a>s from a root node (fact table) to another node
(dimension table), possibly via intermediate dimension tables.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="ProfilerLatticeStatisticProvider.html" title="class in org.apache.calcite.materialize">ProfilerLatticeStatisticProvider</a></th>
<td class="colLast">
<div class="block">Implementation of <a href="LatticeStatisticProvider.html" title="interface in org.apache.calcite.materialize"><code>LatticeStatisticProvider</code></a> that uses a
<a href="../profile/Profiler.html" title="interface in org.apache.calcite.profile"><code>Profiler</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="SqlLatticeStatisticProvider.html" title="class in org.apache.calcite.materialize">SqlLatticeStatisticProvider</a></th>
<td class="colLast">
<div class="block">Implementation of <a href="LatticeStatisticProvider.html" title="interface in org.apache.calcite.materialize"><code>LatticeStatisticProvider</code></a> that gets statistics by
executing "SELECT COUNT(DISTINCT ...) ..." SQL queries.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="Step.html" title="class in org.apache.calcite.materialize">Step</a></th>
<td class="colLast">
<div class="block">Edge in the join graph.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="Step.Factory.html" title="class in org.apache.calcite.materialize">Step.Factory</a></th>
<td class="colLast">
<div class="block">Creates <a href="Step.html" title="class in org.apache.calcite.materialize"><code>Step</code></a> instances.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="TileKey.html" title="class in org.apache.calcite.materialize">TileKey</a></th>
<td class="colLast">
<div class="block">Definition of a particular combination of dimensions and measures of a
lattice that is the basis of a materialization.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="TileSuggester.html" title="class in org.apache.calcite.materialize">TileSuggester</a></th>
<td class="colLast">
<div class="block">Algorithm that suggests a set of initial tiles (materialized aggregate views)
for a given lattice.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="TileSuggester.AttributeImpl.html" title="class in org.apache.calcite.materialize">TileSuggester.AttributeImpl</a></th>
<td class="colLast">
<div class="block">Implementation of <code>Attribute</code> based on a <a href="Lattice.Column.html" title="class in org.apache.calcite.materialize"><code>Lattice.Column</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="TileSuggester.SchemaImpl.html" title="class in org.apache.calcite.materialize">TileSuggester.SchemaImpl</a></th>
<td class="colLast">
<div class="block">Implementation of <code>Schema</code> based on a <a href="Lattice.html" title="class in org.apache.calcite.materialize"><code>Lattice</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="TileSuggester.StatisticsProviderImpl.html" title="class in org.apache.calcite.materialize">TileSuggester.StatisticsProviderImpl</a></th>
<td class="colLast">
<div class="block">Implementation of <code>StatisticsProvider</code>
that asks the lattice.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="TileSuggester.TableImpl.html" title="class in org.apache.calcite.materialize">TileSuggester.TableImpl</a></th>
<td class="colLast">
<div class="block">Implementation of <code>Table</code> based on a <a href="Lattice.html" title="class in org.apache.calcite.materialize"><code>Lattice</code></a>.</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>