| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>QueryProvider (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.linq4j, interface: QueryProvider"> |
| <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.linq4j</a></div> |
| <h1 title="Interface QueryProvider" class="title">Interface QueryProvider</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><code><a href="../jdbc/CalciteConnection.html" title="interface in org.apache.calcite.jdbc">CalciteConnection</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="../adapter/jdbc/JdbcQueryProvider.html" title="class in org.apache.calcite.adapter.jdbc">JdbcQueryProvider</a></code>, <code><a href="QueryProviderImpl.html" title="class in org.apache.calcite.linq4j">QueryProviderImpl</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">QueryProvider</span></div> |
| <div class="block">Defines methods to create and execute queries that are described by a |
| <a href="Queryable.html" title="interface in org.apache.calcite.linq4j"><code>Queryable</code></a> object. |
| |
| <p>Analogous to LINQ's System.Linq.QueryProvider.</p></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><T> <a href="Queryable.html" title="interface in org.apache.calcite.linq4j">Queryable</a><T></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#createQuery(org.apache.calcite.linq4j.tree.Expression,java.lang.Class)" class="member-name-link">createQuery</a><wbr>(<a href="tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a> expression, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> rowType)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Constructs a <a href="Queryable.html" title="interface in org.apache.calcite.linq4j"><code>Queryable</code></a> object that can evaluate the query |
| represented by a specified expression tree.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><T> <a href="Queryable.html" title="interface in org.apache.calcite.linq4j">Queryable</a><T></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#createQuery(org.apache.calcite.linq4j.tree.Expression,java.lang.reflect.Type)" class="member-name-link">createQuery</a><wbr>(<a href="tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a> expression, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/reflect/Type.html" title="class or interface in java.lang.reflect" class="external-link">Type</a> rowType)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Constructs a <a href="Queryable.html" title="interface in org.apache.calcite.linq4j"><code>Queryable</code></a> object that can evaluate the query |
| represented by a specified expression tree.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><T> T</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#execute(org.apache.calcite.linq4j.tree.Expression,java.lang.Class)" class="member-name-link">execute</a><wbr>(<a href="tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a> expression, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> type)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Executes the query represented by a specified expression tree.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><T> T</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#execute(org.apache.calcite.linq4j.tree.Expression,java.lang.reflect.Type)" class="member-name-link">execute</a><wbr>(<a href="tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a> expression, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/reflect/Type.html" title="class or interface in java.lang.reflect" class="external-link">Type</a> type)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Executes the query represented by a specified expression tree.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><T> <a href="Enumerator.html" title="interface in org.apache.calcite.linq4j">Enumerator</a><T></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#executeQuery(org.apache.calcite.linq4j.Queryable)" class="member-name-link">executeQuery</a><wbr>(<a href="Queryable.html" title="interface in org.apache.calcite.linq4j">Queryable</a><T> queryable)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Executes a queryable, and returns an enumerator over the |
| rows that it yields.</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="createQuery(org.apache.calcite.linq4j.tree.Expression,java.lang.Class)"> |
| <h3>createQuery</h3> |
| <div class="member-signature"><span class="type-parameters"><T></span> <span class="return-type"><a href="Queryable.html" title="interface in org.apache.calcite.linq4j">Queryable</a><T></span> <span class="element-name">createQuery</span><wbr><span class="parameters">(<a href="tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a> expression, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> rowType)</span></div> |
| <div class="block">Constructs a <a href="Queryable.html" title="interface in org.apache.calcite.linq4j"><code>Queryable</code></a> object that can evaluate the query |
| represented by a specified expression tree. |
| |
| <p>NOTE: The <a href="RawQueryable.html#getExpression()"><code>RawQueryable.getExpression()</code></a> |
| property of the returned <a href="Queryable.html" title="interface in org.apache.calcite.linq4j"><code>Queryable</code></a> object is equal to |
| <code>expression</code>.</p></div> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>T</code> - Row type</dd> |
| <dt>Parameters:</dt> |
| <dd><code>expression</code> - Expression</dd> |
| <dd><code>rowType</code> - Row type</dd> |
| <dt>Returns:</dt> |
| <dd>Queryable</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createQuery(org.apache.calcite.linq4j.tree.Expression,java.lang.reflect.Type)"> |
| <h3>createQuery</h3> |
| <div class="member-signature"><span class="type-parameters"><T></span> <span class="return-type"><a href="Queryable.html" title="interface in org.apache.calcite.linq4j">Queryable</a><T></span> <span class="element-name">createQuery</span><wbr><span class="parameters">(<a href="tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a> expression, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/reflect/Type.html" title="class or interface in java.lang.reflect" class="external-link">Type</a> rowType)</span></div> |
| <div class="block">Constructs a <a href="Queryable.html" title="interface in org.apache.calcite.linq4j"><code>Queryable</code></a> object that can evaluate the query |
| represented by a specified expression tree. The row type may contain |
| generic information.</div> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>T</code> - Row type</dd> |
| <dt>Parameters:</dt> |
| <dd><code>expression</code> - Expression</dd> |
| <dd><code>rowType</code> - Row type</dd> |
| <dt>Returns:</dt> |
| <dd>Queryable</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="execute(org.apache.calcite.linq4j.tree.Expression,java.lang.Class)"> |
| <h3>execute</h3> |
| <div class="member-signature"><span class="type-parameters"><T></span> <span class="return-type">T</span> <span class="element-name">execute</span><wbr><span class="parameters">(<a href="tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a> expression, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> type)</span></div> |
| <div class="block">Executes the query represented by a specified expression tree. |
| |
| <p>This method executes queries that return a single value |
| (instead of an enumerable sequence of values). Expression trees that |
| represent queries that return enumerable results are executed when the |
| <a href="Queryable.html" title="interface in org.apache.calcite.linq4j"><code>Queryable</code></a> object that contains the expression tree is |
| enumerated.</p> |
| |
| <p>The Queryable standard query operator methods that return singleton |
| results call <code>execute</code>. They pass it a |
| <a href="tree/MethodCallExpression.html" title="class in org.apache.calcite.linq4j.tree"><code>MethodCallExpression</code></a> |
| that represents a linq4j query.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="execute(org.apache.calcite.linq4j.tree.Expression,java.lang.reflect.Type)"> |
| <h3>execute</h3> |
| <div class="member-signature"><span class="type-parameters"><T></span> <span class="return-type">T</span> <span class="element-name">execute</span><wbr><span class="parameters">(<a href="tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a> expression, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/reflect/Type.html" title="class or interface in java.lang.reflect" class="external-link">Type</a> type)</span></div> |
| <div class="block">Executes the query represented by a specified expression tree. |
| The row type may contain type parameters.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="executeQuery(org.apache.calcite.linq4j.Queryable)"> |
| <h3>executeQuery</h3> |
| <div class="member-signature"><span class="type-parameters"><T></span> <span class="return-type"><a href="Enumerator.html" title="interface in org.apache.calcite.linq4j">Enumerator</a><T></span> <span class="element-name">executeQuery</span><wbr><span class="parameters">(<a href="Queryable.html" title="interface in org.apache.calcite.linq4j">Queryable</a><T> queryable)</span></div> |
| <div class="block">Executes a queryable, and returns an enumerator over the |
| rows that it yields.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>queryable</code> - Queryable</dd> |
| <dt>Returns:</dt> |
| <dd>Enumerator over rows</dd> |
| </dl> |
| </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> |
