blob: 7ade2b9e98f071a2beab6de80b781ba1609dc500 [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.calcite.materialize (Apache Calcite calcite 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.calcite.materialize (Apache Calcite calcite 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-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 class="aboutLanguage"><b>Apache Calcite</b></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/calcite/linq4j/tree/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../org/apache/calcite/model/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/calcite/materialize/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.calcite.materialize</h1>
<div class="docSummary">
<div class="block">Management of materialized query results.</div>
</div>
<p>See:&nbsp;<a href="#package.description">Description</a></p>
</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/calcite/materialize/LatticeStatisticProvider.html" title="interface in org.apache.calcite.materialize">LatticeStatisticProvider</a></td>
<td class="colLast">
<div class="block">Estimates row counts for a lattice and its attributes.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/materialize/LatticeStatisticProvider.Factory.html" title="interface in org.apache.calcite.materialize">LatticeStatisticProvider.Factory</a></td>
<td class="colLast">
<div class="block">Creates a <a href="../../../../org/apache/calcite/materialize/LatticeStatisticProvider.html" title="interface in org.apache.calcite.materialize"><code>LatticeStatisticProvider</code></a> for a given
<a href="../../../../org/apache/calcite/materialize/Lattice.html" title="class in org.apache.calcite.materialize"><code>Lattice</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/materialize/MaterializationService.TableFactory.html" title="interface in org.apache.calcite.materialize">MaterializationService.TableFactory</a></td>
<td class="colLast">
<div class="block">Creates tables that represent a materialized view.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/materialize/SqlStatisticProvider.html" title="interface in org.apache.calcite.materialize">SqlStatisticProvider</a></td>
<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" 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/calcite/materialize/DelegatingLatticeStatisticProvider.html" title="class in org.apache.calcite.materialize">DelegatingLatticeStatisticProvider</a></td>
<td class="colLast">
<div class="block">Implementation of <a href="../../../../org/apache/calcite/materialize/LatticeStatisticProvider.html" title="interface in org.apache.calcite.materialize"><code>LatticeStatisticProvider</code></a> that delegates
to an underlying provider.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/materialize/Lattice.html" title="class in org.apache.calcite.materialize">Lattice</a></td>
<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="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/materialize/Lattice.BaseColumn.html" title="class in org.apache.calcite.materialize">Lattice.BaseColumn</a></td>
<td class="colLast">
<div class="block">Column in a lattice.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/materialize/Lattice.Builder.html" title="class in org.apache.calcite.materialize">Lattice.Builder</a></td>
<td class="colLast">
<div class="block">Lattice builder.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/materialize/Lattice.Column.html" title="class in org.apache.calcite.materialize">Lattice.Column</a></td>
<td class="colLast">
<div class="block">Column in a lattice.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/materialize/Lattice.DerivedColumn.html" title="class in org.apache.calcite.materialize">Lattice.DerivedColumn</a></td>
<td class="colLast">
<div class="block">Column in a lattice that is based upon a SQL expression.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/materialize/Lattice.Measure.html" title="class in org.apache.calcite.materialize">Lattice.Measure</a></td>
<td class="colLast">
<div class="block">A measure within a <a href="../../../../org/apache/calcite/materialize/Lattice.html" title="class in org.apache.calcite.materialize"><code>Lattice</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/materialize/Lattice.SqlWriter.html" title="class in org.apache.calcite.materialize">Lattice.SqlWriter</a></td>
<td class="colLast">
<div class="block">The information necessary to convert a column to SQL.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/materialize/Lattice.Tile.html" title="class in org.apache.calcite.materialize">Lattice.Tile</a></td>
<td class="colLast">
<div class="block">Materialized aggregate within a lattice.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/materialize/Lattice.TileBuilder.html" title="class in org.apache.calcite.materialize">Lattice.TileBuilder</a></td>
<td class="colLast">
<div class="block">Tile builder.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/materialize/LatticeChildNode.html" title="class in org.apache.calcite.materialize">LatticeChildNode</a></td>
<td class="colLast">
<div class="block">Non-root node in a <a href="../../../../org/apache/calcite/materialize/Lattice.html" title="class in org.apache.calcite.materialize"><code>Lattice</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/materialize/LatticeNode.html" title="class in org.apache.calcite.materialize">LatticeNode</a></td>
<td class="colLast">
<div class="block">Source relation of a lattice.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/materialize/LatticeRootNode.html" title="class in org.apache.calcite.materialize">LatticeRootNode</a></td>
<td class="colLast">
<div class="block">Root node in a <a href="../../../../org/apache/calcite/materialize/Lattice.html" title="class in org.apache.calcite.materialize"><code>Lattice</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/materialize/Lattices.html" title="class in org.apache.calcite.materialize">Lattices</a></td>
<td class="colLast">
<div class="block">Utilities for <a href="../../../../org/apache/calcite/materialize/Lattice.html" title="class in org.apache.calcite.materialize"><code>Lattice</code></a>, <a href="../../../../org/apache/calcite/materialize/LatticeStatisticProvider.html" title="interface in org.apache.calcite.materialize"><code>LatticeStatisticProvider</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/materialize/LatticeSuggester.html" title="class in org.apache.calcite.materialize">LatticeSuggester</a></td>
<td class="colLast">
<div class="block">Algorithm that suggests a set of lattices.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/materialize/LatticeTable.html" title="class in org.apache.calcite.materialize">LatticeTable</a></td>
<td class="colLast">
<div class="block">Table registered in the graph.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/materialize/MaterializationKey.html" title="class in org.apache.calcite.materialize">MaterializationKey</a></td>
<td class="colLast">
<div class="block">Unique identifier for a materialization.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/materialize/MaterializationService.html" title="class in org.apache.calcite.materialize">MaterializationService</a></td>
<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">
<td class="colFirst"><a href="../../../../org/apache/calcite/materialize/MaterializationService.DefaultTableFactory.html" title="class in org.apache.calcite.materialize">MaterializationService.DefaultTableFactory</a></td>
<td class="colLast">
<div class="block">Default implementation of <a href="../../../../org/apache/calcite/materialize/MaterializationService.TableFactory.html" title="interface in org.apache.calcite.materialize"><code>MaterializationService.TableFactory</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/calcite/materialize/TileKey.html" title="class in org.apache.calcite.materialize">TileKey</a></td>
<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">
<td class="colFirst"><a href="../../../../org/apache/calcite/materialize/TileSuggester.html" title="class in org.apache.calcite.materialize">TileSuggester</a></td>
<td class="colLast">
<div class="block">Algorithm that suggests a set of initial tiles (materialized aggregate views)
for a given lattice.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.calcite.materialize Description">Package org.apache.calcite.materialize Description</h2>
<div class="block">Management of materialized query results.
<p>An actor (<code>MaterializationActor</code>)
maintains the state of all
materializations in the system and is wrapped in a service
(<a href="../../../../org/apache/calcite/materialize/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>
</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-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 class="aboutLanguage"><b>Apache Calcite</b></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/calcite/linq4j/tree/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../org/apache/calcite/model/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/calcite/materialize/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 &copy; 2012-2020 Apache Software Foundation. All Rights Reserved.</small></p>
</body>
</html>