| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>SqlStatisticProvider (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, interface: SqlStatisticProvider"> |
| <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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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> <a href="package-summary.html">org.apache.calcite.materialize</a></div> |
| <h1 title="Interface SqlStatisticProvider" class="title">Interface SqlStatisticProvider</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="../statistic/CachingSqlStatisticProvider.html" title="class in org.apache.calcite.statistic">CachingSqlStatisticProvider</a></code>, <code><a href="../statistic/MapSqlStatisticProvider.html" title="enum in org.apache.calcite.statistic">MapSqlStatisticProvider</a></code>, <code><a href="../statistic/QuerySqlStatisticProvider.html" title="class in org.apache.calcite.statistic">QuerySqlStatisticProvider</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">SqlStatisticProvider</span></div> |
| <div class="block">Estimates row counts for tables and columns, and whether combinations of |
| columns form primary/unique and foreign keys. |
| |
| <p>Unlike <a href="LatticeStatisticProvider.html" title="interface in org.apache.calcite.materialize"><code>LatticeStatisticProvider</code></a>, works on raw tables and columns |
| and does not need a <a href="Lattice.html" title="class in org.apache.calcite.materialize"><code>Lattice</code></a>. |
| |
| <p>It uses <a href="../plan/RelOptTable.html" title="interface in org.apache.calcite.plan"><code>RelOptTable</code></a> because that contains |
| enough information to generate and execute SQL, while not being tied to a |
| lattice. |
| |
| <p>The main implementation, |
| <a href="../statistic/QuerySqlStatisticProvider.html" title="class in org.apache.calcite.statistic"><code>QuerySqlStatisticProvider</code></a>, executes |
| queries on a populated database. Implementations that use database statistics |
| (from <code>ANALYZE TABLE</code>, etc.) and catalog information (e.g. primary and |
| foreign key constraints) would also be possible.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== 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-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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract 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-tab3"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isForeignKey(org.apache.calcite.plan.RelOptTable,java.util.List,org.apache.calcite.plan.RelOptTable,java.util.List)" class="member-name-link">isForeignKey</a><wbr>(<a href="../plan/RelOptTable.html" title="interface in org.apache.calcite.plan">RelOptTable</a> fromTable, |
| <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><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>> fromColumns, |
| <a href="../plan/RelOptTable.html" title="interface in org.apache.calcite.plan">RelOptTable</a> toTable, |
| <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><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>> toColumns)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns whether a join is a foreign key; that is, whether every row in |
| the referencing table is matched by at least one row in the referenced |
| table.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isKey(org.apache.calcite.plan.RelOptTable,java.util.List)" class="member-name-link">isKey</a><wbr>(<a href="../plan/RelOptTable.html" title="interface in org.apache.calcite.plan">RelOptTable</a> table, |
| <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><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>> columns)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns whether a collection of columns is a unique (or primary) key.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>double</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#tableCardinality(org.apache.calcite.plan.RelOptTable)" class="member-name-link">tableCardinality</a><wbr>(<a href="../plan/RelOptTable.html" title="interface in org.apache.calcite.plan">RelOptTable</a> table)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns an estimate of the number of rows in <code>table</code>.</div> |
| </div> |
| </div> |
| </div> |
| </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="tableCardinality(org.apache.calcite.plan.RelOptTable)"> |
| <h3>tableCardinality</h3> |
| <div class="member-signature"><span class="return-type">double</span> <span class="element-name">tableCardinality</span><wbr><span class="parameters">(<a href="../plan/RelOptTable.html" title="interface in org.apache.calcite.plan">RelOptTable</a> table)</span></div> |
| <div class="block">Returns an estimate of the number of rows in <code>table</code>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isForeignKey(org.apache.calcite.plan.RelOptTable,java.util.List,org.apache.calcite.plan.RelOptTable,java.util.List)"> |
| <h3>isForeignKey</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isForeignKey</span><wbr><span class="parameters">(<a href="../plan/RelOptTable.html" title="interface in org.apache.calcite.plan">RelOptTable</a> fromTable, |
| <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><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>> fromColumns, |
| <a href="../plan/RelOptTable.html" title="interface in org.apache.calcite.plan">RelOptTable</a> toTable, |
| <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><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>> toColumns)</span></div> |
| <div class="block">Returns whether a join is a foreign key; that is, whether every row in |
| the referencing table is matched by at least one row in the referenced |
| table. |
| |
| <p>For example, <code>isForeignKey(EMP, [DEPTNO], DEPT, [DEPTNO])</code> |
| returns true. |
| |
| <p>To change "at least one" to "exactly one", you also need to call |
| <a href="#isKey(org.apache.calcite.plan.RelOptTable,java.util.List)"><code>isKey(org.apache.calcite.plan.RelOptTable, java.util.List<java.lang.Integer>)</code></a>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isKey(org.apache.calcite.plan.RelOptTable,java.util.List)"> |
| <h3>isKey</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isKey</span><wbr><span class="parameters">(<a href="../plan/RelOptTable.html" title="interface in org.apache.calcite.plan">RelOptTable</a> table, |
| <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><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>> columns)</span></div> |
| <div class="block">Returns whether a collection of columns is a unique (or primary) key. |
| |
| <p>For example, <code>isKey(EMP, [DEPTNO]</code> returns true; |
| <p>For example, <code>isKey(DEPT, [DEPTNO]</code> returns false.</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2012-2023 Apache Software Foundation. All Rights Reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
