| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>QueryProvider (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.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.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="class-declaration"> |
| <script type="text/javascript">var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| 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><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">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> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <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"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.calcite.linq4j</a></div> |
| <h1 title="Interface QueryProvider" class="title">Interface QueryProvider</h1> |
| </div> |
| <div class="contentContainer"> |
| <section class="description"> |
| <dl> |
| <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> |
| <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> |
| <pre>public interface <span class="typeNameLabel">QueryProvider</span></pre> |
| <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="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li class="blockList"> |
| <section class="methodSummary"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h2>Method Summary</h2> |
| <div class="memberSummary"> |
| <div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="tableTab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t3" class="tableTab" onclick="show(4);">Abstract Methods</button></div> |
| <div id="memberSummary_tabpanel" role="tabpanel"> |
| <table aria-labelledby="t0"> |
| <thead> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="altColor" id="i0"> |
| <td class="colFirst"><code><T> <a href="Queryable.html" title="interface in org.apache.calcite.linq4j">Queryable</a><T></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createQuery(org.apache.calcite.linq4j.tree.Expression,java.lang.Class)">createQuery</a></span>​(<a href="tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a> expression, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><T> rowType)</code></th> |
| <td class="colLast"> |
| <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> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i1"> |
| <td class="colFirst"><code><T> <a href="Queryable.html" title="interface in org.apache.calcite.linq4j">Queryable</a><T></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createQuery(org.apache.calcite.linq4j.tree.Expression,java.lang.reflect.Type)">createQuery</a></span>​(<a href="tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a> expression, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/reflect/Type.html?is-external=true" title="class or interface in java.lang.reflect" class="externalLink">Type</a> rowType)</code></th> |
| <td class="colLast"> |
| <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> |
| </td> |
| </tr> |
| <tr class="altColor" id="i2"> |
| <td class="colFirst"><code><T> T</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#execute(org.apache.calcite.linq4j.tree.Expression,java.lang.Class)">execute</a></span>​(<a href="tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a> expression, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a><T> type)</code></th> |
| <td class="colLast"> |
| <div class="block">Executes the query represented by a specified expression tree.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i3"> |
| <td class="colFirst"><code><T> T</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#execute(org.apache.calcite.linq4j.tree.Expression,java.lang.reflect.Type)">execute</a></span>​(<a href="tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a> expression, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/reflect/Type.html?is-external=true" title="class or interface in java.lang.reflect" class="externalLink">Type</a> type)</code></th> |
| <td class="colLast"> |
| <div class="block">Executes the query represented by a specified expression tree.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i4"> |
| <td class="colFirst"><code><T> <a href="Enumerator.html" title="interface in org.apache.calcite.linq4j">Enumerator</a><T></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#executeQuery(org.apache.calcite.linq4j.Queryable)">executeQuery</a></span>​(<a href="Queryable.html" title="interface in org.apache.calcite.linq4j">Queryable</a><T> queryable)</code></th> |
| <td class="colLast"> |
| <div class="block">Executes a queryable, and returns an enumerator over the |
| rows that it yields.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li class="blockList"> |
| <section class="methodDetails"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h2>Method Details</h2> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="createQuery(org.apache.calcite.linq4j.tree.Expression,java.lang.Class)">createQuery</a></h3> |
| <div class="memberSignature"><span class="typeParameters"><T></span> <span class="returnType"><a href="Queryable.html" title="interface in org.apache.calcite.linq4j">Queryable</a><T></span> <span class="memberName">createQuery</span>​(<span class="arguments"><a href="tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a> expression, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">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> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - Row type</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>expression</code> - Expression</dd> |
| <dd><code>rowType</code> - Row type</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Queryable</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="createQuery(org.apache.calcite.linq4j.tree.Expression,java.lang.reflect.Type)">createQuery</a></h3> |
| <div class="memberSignature"><span class="typeParameters"><T></span> <span class="returnType"><a href="Queryable.html" title="interface in org.apache.calcite.linq4j">Queryable</a><T></span> <span class="memberName">createQuery</span>​(<span class="arguments"><a href="tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a> expression, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/reflect/Type.html?is-external=true" title="class or interface in java.lang.reflect" class="externalLink">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> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - Row type</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>expression</code> - Expression</dd> |
| <dd><code>rowType</code> - Row type</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Queryable</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="execute(org.apache.calcite.linq4j.tree.Expression,java.lang.Class)">execute</a></h3> |
| <div class="memberSignature"><span class="typeParameters"><T></span> <span class="returnType">T</span> <span class="memberName">execute</span>​(<span class="arguments"><a href="tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a> expression, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="execute(org.apache.calcite.linq4j.tree.Expression,java.lang.reflect.Type)">execute</a></h3> |
| <div class="memberSignature"><span class="typeParameters"><T></span> <span class="returnType">T</span> <span class="memberName">execute</span>​(<span class="arguments"><a href="tree/Expression.html" title="class in org.apache.calcite.linq4j.tree">Expression</a> expression, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/reflect/Type.html?is-external=true" title="class or interface in java.lang.reflect" class="externalLink">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 class="blockList"> |
| <section class="detail"> |
| <h3><a id="executeQuery(org.apache.calcite.linq4j.Queryable)">executeQuery</a></h3> |
| <div class="memberSignature"><span class="typeParameters"><T></span> <span class="returnType"><a href="Enumerator.html" title="interface in org.apache.calcite.linq4j">Enumerator</a><T></span> <span class="memberName">executeQuery</span>​(<span class="arguments"><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> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>queryable</code> - Queryable</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Enumerator over rows</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </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><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">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> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </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> |
