javadocAggregate/org/apache/calcite/materialize/MaterializationService.html - calcite-site - Git at Google

 <!DOCTYPE HTML>
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
 <title>MaterializationService (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, class: MaterializationService">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <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="class-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><a href="package-summary.html">Package</a></li>
 <li class="nav-bar-cell1-rev">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#class">Help</a></li>
 </ul>
 </div>
 <div class="sub-nav">
 <div>
 <ul class="sub-nav-list">
 <li>Summary:&nbsp;</li>
 <li><a href="#nested-class-summary">Nested</a>&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method-summary">Method</a></li>
 </ul>
 <ul class="sub-nav-list">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method-detail">Method</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">
 <!-- ======== START OF CLASS DATA ======== -->
 <div class="header">
 <div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.calcite.materialize</a></div>
 <h1 title="Class MaterializationService" class="title">Class MaterializationService</h1>
 </div>
 <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
 <div class="inheritance">org.apache.calcite.materialize.MaterializationService</div>
 </div>
 <section class="class-description" id="class-description">
 <hr>
 <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">MaterializationService</span>
 <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
 <div class="block">Manages the collection of materialized tables known to the system,
  and the process by which they become valid and invalid.</div>
 </section>
 <section class="summary">
 <ul class="summary-list">
 <!-- ======== NESTED CLASS SUMMARY ======== -->
 <li>
 <section class="nested-class-summary" id="nested-class-summary">
 <h2>Nested Class Summary</h2>
 <div class="caption"><span>Nested Classes</span></div>
 <div class="summary-table three-column-summary">
 <div class="table-header col-first">Modifier and Type</div>
 <div class="table-header col-second">Class</div>
 <div class="table-header col-last">Description</div>
 <div class="col-first even-row-color"><code>static class&nbsp;</code></div>
 <div class="col-second even-row-color"><code><a href="MaterializationService.DefaultTableFactory.html" class="type-name-link" title="class in org.apache.calcite.materialize">MaterializationService.DefaultTableFactory</a></code></div>
 <div class="col-last even-row-color">
 <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"><code>static interface&nbsp;</code></div>
 <div class="col-second odd-row-color"><code><a href="MaterializationService.TableFactory.html" class="type-name-link" title="interface in org.apache.calcite.materialize">MaterializationService.TableFactory</a></code></div>
 <div class="col-last odd-row-color">
 <div class="block">Creates tables that represent a materialized view.</div>
 </div>
 </div>
 </section>
 </li>
 <!-- ========== METHOD SUMMARY =========== -->
 <li>
 <section class="method-summary" id="method-summary">
 <h2>Method Summary</h2>
 <div id="method-summary-table">
 <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
 <div id="method-summary-table.tabpanel" role="tabpanel">
 <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
 <div class="table-header col-first">Modifier and Type</div>
 <div class="table-header col-second">Method</div>
 <div class="table-header col-last">Description</div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@Nullable <a href="../jdbc/CalciteSchema.TableEntry.html" title="class in org.apache.calcite.jdbc">CalciteSchema.TableEntry</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#checkValid(org.apache.calcite.materialize.MaterializationKey)" class="member-name-link">checkValid</a><wbr>(<a href="MaterializationKey.html" title="class in org.apache.calcite.materialize">MaterializationKey</a>&nbsp;key)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Checks whether a materialization is valid, and if so, returns the table
  where the data are stored.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#clear()" class="member-name-link">clear</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">De-registers all materialized tables in the system.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@Nullable <a href="MaterializationKey.html" title="class in org.apache.calcite.materialize">MaterializationKey</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#defineMaterialization(org.apache.calcite.jdbc.CalciteSchema,org.apache.calcite.materialize.TileKey,java.lang.String,java.util.List,java.lang.String,boolean,boolean)" class="member-name-link">defineMaterialization</a><wbr>(<a href="../jdbc/CalciteSchema.html" title="class in org.apache.calcite.jdbc">CalciteSchema</a>&nbsp;schema,
  @Nullable <a href="TileKey.html" title="class in org.apache.calcite.materialize">TileKey</a>&nbsp;tileKey,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;viewSql,
  @Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;viewSchemaPath,
  @Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;suggestedTableName,
  boolean&nbsp;create,
  boolean&nbsp;existing)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Defines a new materialization.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@Nullable <a href="MaterializationKey.html" title="class in org.apache.calcite.materialize">MaterializationKey</a></code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#defineMaterialization(org.apache.calcite.jdbc.CalciteSchema,org.apache.calcite.materialize.TileKey,java.lang.String,java.util.List,java.lang.String,org.apache.calcite.materialize.MaterializationService.TableFactory,boolean,boolean)" class="member-name-link">defineMaterialization</a><wbr>(<a href="../jdbc/CalciteSchema.html" title="class in org.apache.calcite.jdbc">CalciteSchema</a>&nbsp;schema,
  @Nullable <a href="TileKey.html" title="class in org.apache.calcite.materialize">TileKey</a>&nbsp;tileKey,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;viewSql,
  @Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;viewSchemaPath,
  @Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;suggestedTableName,
  <a href="MaterializationService.TableFactory.html" title="interface in org.apache.calcite.materialize">MaterializationService.TableFactory</a>&nbsp;tableFactory,
  boolean&nbsp;create,
  boolean&nbsp;existing)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Defines a new materialization.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@Nullable <a href="../util/Pair.html" title="class in org.apache.calcite.util">Pair</a>&lt;<a href="../jdbc/CalciteSchema.TableEntry.html" title="class in org.apache.calcite.jdbc">CalciteSchema.TableEntry</a>,<wbr><a href="TileKey.html" title="class in org.apache.calcite.materialize">TileKey</a>&gt;</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#defineTile(org.apache.calcite.materialize.Lattice,org.apache.calcite.util.ImmutableBitSet,java.util.List,org.apache.calcite.jdbc.CalciteSchema,boolean,boolean)" class="member-name-link">defineTile</a><wbr>(<a href="Lattice.html" title="class in org.apache.calcite.materialize">Lattice</a>&nbsp;lattice,
  <a href="../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a>&nbsp;groupSet,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="Lattice.Measure.html" title="class in org.apache.calcite.materialize">Lattice.Measure</a>&gt;&nbsp;measureList,
  <a href="../jdbc/CalciteSchema.html" title="class in org.apache.calcite.jdbc">CalciteSchema</a>&nbsp;schema,
  boolean&nbsp;create,
  boolean&nbsp;exact)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Defines a tile.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@Nullable <a href="../util/Pair.html" title="class in org.apache.calcite.util">Pair</a>&lt;<a href="../jdbc/CalciteSchema.TableEntry.html" title="class in org.apache.calcite.jdbc">CalciteSchema.TableEntry</a>,<wbr><a href="TileKey.html" title="class in org.apache.calcite.materialize">TileKey</a>&gt;</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#defineTile(org.apache.calcite.materialize.Lattice,org.apache.calcite.util.ImmutableBitSet,java.util.List,org.apache.calcite.jdbc.CalciteSchema,boolean,boolean,java.lang.String,org.apache.calcite.materialize.MaterializationService.TableFactory)" class="member-name-link">defineTile</a><wbr>(<a href="Lattice.html" title="class in org.apache.calcite.materialize">Lattice</a>&nbsp;lattice,
  <a href="../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a>&nbsp;groupSet,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="Lattice.Measure.html" title="class in org.apache.calcite.materialize">Lattice.Measure</a>&gt;&nbsp;measureList,
  <a href="../jdbc/CalciteSchema.html" title="class in org.apache.calcite.jdbc">CalciteSchema</a>&nbsp;schema,
  boolean&nbsp;create,
  boolean&nbsp;exact,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;suggestedTableName,
  <a href="MaterializationService.TableFactory.html" title="interface in org.apache.calcite.materialize">MaterializationService.TableFactory</a>&nbsp;tableFactory)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="MaterializationService.html" title="class in org.apache.calcite.materialize">MaterializationService</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#instance()" class="member-name-link">instance</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
 <div class="block">Returns the instance of the materialization service.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="../prepare/Prepare.Materialization.html" title="class in org.apache.calcite.prepare">Prepare.Materialization</a>&gt;</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#query(org.apache.calcite.jdbc.CalciteSchema)" class="member-name-link">query</a><wbr>(<a href="../jdbc/CalciteSchema.html" title="class in org.apache.calcite.jdbc">CalciteSchema</a>&nbsp;rootSchema)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Gathers a list of all materialized tables known within a given root
  schema.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#removeMaterialization(org.apache.calcite.materialize.MaterializationKey)" class="member-name-link">removeMaterialization</a><wbr>(<a href="MaterializationKey.html" title="class in org.apache.calcite.materialize">MaterializationKey</a>&nbsp;key)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#setThreadLocal()" class="member-name-link">setThreadLocal</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
 <div class="block">Used by tests, to ensure that they see their own service.</div>
 </div>
 </div>
 </div>
 </div>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
 <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
 </section>
 </li>
 </ul>
 </section>
 <section class="details">
 <ul class="details-list">
 <!-- ============ METHOD DETAIL ========== -->
 <li>
 <section class="method-details" id="method-detail">
 <h2>Method Details</h2>
 <ul class="member-list">
 <li>
 <section class="detail" id="defineMaterialization(org.apache.calcite.jdbc.CalciteSchema,org.apache.calcite.materialize.TileKey,java.lang.String,java.util.List,java.lang.String,boolean,boolean)">
 <h3>defineMaterialization</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">@Nullable <a href="MaterializationKey.html" title="class in org.apache.calcite.materialize">MaterializationKey</a></span>&nbsp;<span class="element-name">defineMaterialization</span><wbr><span class="parameters">(<a href="../jdbc/CalciteSchema.html" title="class in org.apache.calcite.jdbc">CalciteSchema</a>&nbsp;schema,
  @Nullable <a href="TileKey.html" title="class in org.apache.calcite.materialize">TileKey</a>&nbsp;tileKey,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;viewSql,
  @Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;viewSchemaPath,
  @Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;suggestedTableName,
  boolean&nbsp;create,
  boolean&nbsp;existing)</span></div>
 <div class="block">Defines a new materialization. Returns its key.</div>
 </section>
 </li>
 <li>
 <section class="detail" id="defineMaterialization(org.apache.calcite.jdbc.CalciteSchema,org.apache.calcite.materialize.TileKey,java.lang.String,java.util.List,java.lang.String,org.apache.calcite.materialize.MaterializationService.TableFactory,boolean,boolean)">
 <h3>defineMaterialization</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">@Nullable <a href="MaterializationKey.html" title="class in org.apache.calcite.materialize">MaterializationKey</a></span>&nbsp;<span class="element-name">defineMaterialization</span><wbr><span class="parameters">(<a href="../jdbc/CalciteSchema.html" title="class in org.apache.calcite.jdbc">CalciteSchema</a>&nbsp;schema,
  @Nullable <a href="TileKey.html" title="class in org.apache.calcite.materialize">TileKey</a>&nbsp;tileKey,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;viewSql,
  @Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;viewSchemaPath,
  @Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;suggestedTableName,
  <a href="MaterializationService.TableFactory.html" title="interface in org.apache.calcite.materialize">MaterializationService.TableFactory</a>&nbsp;tableFactory,
  boolean&nbsp;create,
  boolean&nbsp;existing)</span></div>
 <div class="block">Defines a new materialization. Returns its key.</div>
 </section>
 </li>
 <li>
 <section class="detail" id="checkValid(org.apache.calcite.materialize.MaterializationKey)">
 <h3>checkValid</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">@Nullable <a href="../jdbc/CalciteSchema.TableEntry.html" title="class in org.apache.calcite.jdbc">CalciteSchema.TableEntry</a></span>&nbsp;<span class="element-name">checkValid</span><wbr><span class="parameters">(<a href="MaterializationKey.html" title="class in org.apache.calcite.materialize">MaterializationKey</a>&nbsp;key)</span></div>
 <div class="block">Checks whether a materialization is valid, and if so, returns the table
  where the data are stored.</div>
 </section>
 </li>
 <li>
 <section class="detail" id="defineTile(org.apache.calcite.materialize.Lattice,org.apache.calcite.util.ImmutableBitSet,java.util.List,org.apache.calcite.jdbc.CalciteSchema,boolean,boolean)">
 <h3>defineTile</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">@Nullable <a href="../util/Pair.html" title="class in org.apache.calcite.util">Pair</a>&lt;<a href="../jdbc/CalciteSchema.TableEntry.html" title="class in org.apache.calcite.jdbc">CalciteSchema.TableEntry</a>,<wbr><a href="TileKey.html" title="class in org.apache.calcite.materialize">TileKey</a>&gt;</span>&nbsp;<span class="element-name">defineTile</span><wbr><span class="parameters">(<a href="Lattice.html" title="class in org.apache.calcite.materialize">Lattice</a>&nbsp;lattice,
  <a href="../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a>&nbsp;groupSet,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="Lattice.Measure.html" title="class in org.apache.calcite.materialize">Lattice.Measure</a>&gt;&nbsp;measureList,
  <a href="../jdbc/CalciteSchema.html" title="class in org.apache.calcite.jdbc">CalciteSchema</a>&nbsp;schema,
  boolean&nbsp;create,
  boolean&nbsp;exact)</span></div>
 <div class="block">Defines a tile.

  <p>Setting the <code>create</code> flag to false prevents a materialization
  from being created if one does not exist. Critically, it is set to false
  during the recursive SQL that populates a materialization. Otherwise a
  materialization would try to create itself to populate itself!</div>
 </section>
 </li>
 <li>
 <section class="detail" id="defineTile(org.apache.calcite.materialize.Lattice,org.apache.calcite.util.ImmutableBitSet,java.util.List,org.apache.calcite.jdbc.CalciteSchema,boolean,boolean,java.lang.String,org.apache.calcite.materialize.MaterializationService.TableFactory)">
 <h3>defineTile</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">@Nullable <a href="../util/Pair.html" title="class in org.apache.calcite.util">Pair</a>&lt;<a href="../jdbc/CalciteSchema.TableEntry.html" title="class in org.apache.calcite.jdbc">CalciteSchema.TableEntry</a>,<wbr><a href="TileKey.html" title="class in org.apache.calcite.materialize">TileKey</a>&gt;</span>&nbsp;<span class="element-name">defineTile</span><wbr><span class="parameters">(<a href="Lattice.html" title="class in org.apache.calcite.materialize">Lattice</a>&nbsp;lattice,
  <a href="../util/ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a>&nbsp;groupSet,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="Lattice.Measure.html" title="class in org.apache.calcite.materialize">Lattice.Measure</a>&gt;&nbsp;measureList,
  <a href="../jdbc/CalciteSchema.html" title="class in org.apache.calcite.jdbc">CalciteSchema</a>&nbsp;schema,
  boolean&nbsp;create,
  boolean&nbsp;exact,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;suggestedTableName,
  <a href="MaterializationService.TableFactory.html" title="interface in org.apache.calcite.materialize">MaterializationService.TableFactory</a>&nbsp;tableFactory)</span></div>
 </section>
 </li>
 <li>
 <section class="detail" id="query(org.apache.calcite.jdbc.CalciteSchema)">
 <h3>query</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="../prepare/Prepare.Materialization.html" title="class in org.apache.calcite.prepare">Prepare.Materialization</a>&gt;</span>&nbsp;<span class="element-name">query</span><wbr><span class="parameters">(<a href="../jdbc/CalciteSchema.html" title="class in org.apache.calcite.jdbc">CalciteSchema</a>&nbsp;rootSchema)</span></div>
 <div class="block">Gathers a list of all materialized tables known within a given root
  schema. (Each root schema defines a disconnected namespace, with no overlap
  with the current schema. Especially in a test run, the contents of two
  root schemas may look similar.)</div>
 </section>
 </li>
 <li>
 <section class="detail" id="clear()">
 <h3>clear</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">clear</span>()</div>
 <div class="block">De-registers all materialized tables in the system.</div>
 </section>
 </li>
 <li>
 <section class="detail" id="setThreadLocal()">
 <h3>setThreadLocal</h3>
 <div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setThreadLocal</span>()</div>
 <div class="block">Used by tests, to ensure that they see their own service.</div>
 </section>
 </li>
 <li>
 <section class="detail" id="instance()">
 <h3>instance</h3>
 <div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="MaterializationService.html" title="class in org.apache.calcite.materialize">MaterializationService</a></span>&nbsp;<span class="element-name">instance</span>()</div>
 <div class="block">Returns the instance of the materialization service. Usually the global
  one, but returns a thread-local one during testing (when
  <a href="#setThreadLocal()"><code>setThreadLocal()</code></a> has been called by the current thread).</div>
 </section>
 </li>
 <li>
 <section class="detail" id="removeMaterialization(org.apache.calcite.materialize.MaterializationKey)">
 <h3>removeMaterialization</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">removeMaterialization</span><wbr><span class="parameters">(<a href="MaterializationKey.html" title="class in org.apache.calcite.materialize">MaterializationKey</a>&nbsp;key)</span></div>
 </section>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </section>
 <!-- ========= END OF CLASS DATA ========= -->
 </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>