| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>org.apache.calcite.materialize (Apache Calcite calcite API)</title> |
| <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.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../script-dir/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../script-dir/jquery-3.4.1.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-ui.js"></script> |
| </head> |
| <body class="package-declaration"> |
| <script type="text/javascript">var pathtoroot = "../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flexBox"> |
| <header role="banner" class="flexHeader"> |
| <nav role="navigation"> |
| <!-- ========= 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-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"> |
| <div class="navListSearch"><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="skipNav"><a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| </nav> |
| </header> |
| <div class="flexContent"> |
| <main role="main"> |
| <div class="header"> |
| <p>@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) |
| </p> |
| <h1 title="Package" class="title">Package org.apache.calcite.materialize</h1> |
| </div> |
| <div class="contentContainer"> |
| <section class="packageDescription"><a id="package.description"> |
| <!-- --> |
| </a> |
| <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="blockList"> |
| <li class="blockList"> |
| <div class="typeSummary"> |
| <table> |
| <caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> |
| <thead> |
| <tr> |
| <th class="colFirst" scope="col">Interface</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| </thead> |
| <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> |
| </div> |
| </li> |
| <li class="blockList"> |
| <div class="typeSummary"> |
| <table> |
| <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> |
| <thead> |
| <tr> |
| <th class="colFirst" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="altColor"> |
| <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="rowColor"> |
| <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="altColor"> |
| <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="rowColor"> |
| <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="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.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="rowColor"> |
| <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="altColor"> |
| <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="rowColor"> |
| <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="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="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="rowColor"> |
| <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="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="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> |
| </tbody> |
| </table> |
| </div> |
| </li> |
| </ul> |
| </section> |
| </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-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> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2012-2021 Apache Software Foundation. All Rights Reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
