blob: 3e85fb0b7f843743918969d3fdf990e647aee9df [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>org.apache.calcite.materialize (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.materialize">
<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.materialize" class="title">Package org.apache.calcite.materialize</h1>
</div>
<hr>
<div class="package-signature"><span class="annotations">@DefaultQualifier(value=org.checkerframework.checker.nullness.qual.NonNull.class,locations=FIELD) @DefaultQualifier(value=org.checkerframework.checker.nullness.qual.NonNull.class,locations=PARAMETER) @DefaultQualifier(value=org.checkerframework.checker.nullness.qual.NonNull.class,locations=RETURN)
</span>package <span class="element-name">org.apache.calcite.materialize</span></div>
<section class="package-description" id="package-description">
<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="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>
<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></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="DelegatingLatticeStatisticProvider.html" title="class in org.apache.calcite.materialize">DelegatingLatticeStatisticProvider</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<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>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Lattice.html" title="class in org.apache.calcite.materialize">Lattice</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Structure that allows materialized views based upon a star schema to be
recognized and recommended.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Lattice.BaseColumn.html" title="class in org.apache.calcite.materialize">Lattice.BaseColumn</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Column in a lattice.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Lattice.Builder.html" title="class in org.apache.calcite.materialize">Lattice.Builder</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Lattice builder.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Lattice.Column.html" title="class in org.apache.calcite.materialize">Lattice.Column</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Column in a lattice.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Lattice.DerivedColumn.html" title="class in org.apache.calcite.materialize">Lattice.DerivedColumn</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Column in a lattice that is based upon a SQL expression.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Lattice.Measure.html" title="class in org.apache.calcite.materialize">Lattice.Measure</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">A measure within a <a href="Lattice.html" title="class in org.apache.calcite.materialize"><code>Lattice</code></a>.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Lattice.SqlWriter.html" title="class in org.apache.calcite.materialize">Lattice.SqlWriter</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">The information necessary to convert a column to SQL.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Lattice.Tile.html" title="class in org.apache.calcite.materialize">Lattice.Tile</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Materialized aggregate within a lattice.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Lattice.TileBuilder.html" title="class in org.apache.calcite.materialize">Lattice.TileBuilder</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Tile builder.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="LatticeChildNode.html" title="class in org.apache.calcite.materialize">LatticeChildNode</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Non-root node in a <a href="Lattice.html" title="class in org.apache.calcite.materialize"><code>Lattice</code></a>.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="LatticeNode.html" title="class in org.apache.calcite.materialize">LatticeNode</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Source relation of a lattice.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="LatticeRootNode.html" title="class in org.apache.calcite.materialize">LatticeRootNode</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Root node in a <a href="Lattice.html" title="class in org.apache.calcite.materialize"><code>Lattice</code></a>.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Lattices.html" title="class in org.apache.calcite.materialize">Lattices</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<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>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="LatticeStatisticProvider.html" title="interface in org.apache.calcite.materialize">LatticeStatisticProvider</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">Estimates row counts for a lattice and its attributes.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="LatticeStatisticProvider.Factory.html" title="interface in org.apache.calcite.materialize">LatticeStatisticProvider.Factory</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<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>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="LatticeSuggester.html" title="class in org.apache.calcite.materialize">LatticeSuggester</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Algorithm that suggests a set of lattices.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="LatticeTable.html" title="class in org.apache.calcite.materialize">LatticeTable</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Table registered in the graph.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="MaterializationKey.html" title="class in org.apache.calcite.materialize">MaterializationKey</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Unique identifier for a materialization.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="MaterializationService.html" title="class in org.apache.calcite.materialize">MaterializationService</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Manages the collection of materialized tables known to the system,
and the process by which they become valid and invalid.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="MaterializationService.DefaultTableFactory.html" title="class in org.apache.calcite.materialize">MaterializationService.DefaultTableFactory</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Default implementation of <a href="MaterializationService.TableFactory.html" title="interface in org.apache.calcite.materialize"><code>MaterializationService.TableFactory</code></a>.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="MaterializationService.TableFactory.html" title="interface in org.apache.calcite.materialize">MaterializationService.TableFactory</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Creates tables that represent a materialized view.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="SqlStatisticProvider.html" title="interface in org.apache.calcite.materialize">SqlStatisticProvider</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">Estimates row counts for tables and columns, and whether combinations of
columns form primary/unique and foreign keys.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="TileKey.html" title="class in org.apache.calcite.materialize">TileKey</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Definition of a particular combination of dimensions and measures of a
lattice that is the basis of a materialization.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="TileSuggester.html" title="class in org.apache.calcite.materialize">TileSuggester</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Algorithm that suggests a set of initial tiles (materialized aggregate views)
for a given lattice.</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>