| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>org.apache.calcite.jdbc (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.jdbc"> |
| <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.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="package-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 class="nav-bar-cell1-rev">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#package">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Package: </li> |
| <li><a href="#package-description">Description</a> | </li> |
| <li><a href="#related-package-summary">Related Packages</a> | </li> |
| <li><a href="#class-summary">Classes and Interfaces</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"> |
| <div class="header"> |
| <h1 title="Package org.apache.calcite.jdbc" class="title">Package org.apache.calcite.jdbc</h1> |
| </div> |
| <hr> |
| <div class="package-signature"><span class="annotations">@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) |
| </span>package <span class="element-name">org.apache.calcite.jdbc</span></div> |
| <section class="package-description" id="package-description"> |
| <div class="block">JDBC driver for Calcite.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <li> |
| <div id="related-package-summary"> |
| <div class="caption"><span>Related Packages</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Package</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><a href="../package-summary.html">org.apache.calcite</a></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Main package for Calcite, the dynamic data management platform.</div> |
| </div> |
| </div> |
| </div> |
| </li> |
| <li> |
| <div id="class-summary"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab1" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab1', 2)" class="table-tab">Interfaces</button><button id="class-summary-tab2" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab2', 2)" class="table-tab">Classes</button><button id="class-summary-tab5" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab5', 2)" class="table-tab">Exceptions</button></div> |
| <div id="class-summary.tabpanel" role="tabpanel"> |
| <div class="summary-table two-column-summary" aria-labelledby="class-summary-tab0"> |
| <div class="table-header col-first">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="CalciteConnection.html" title="interface in org.apache.calcite.jdbc">CalciteConnection</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Extension to Calcite's implementation of |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/java/sql/Connection.html" title="class or interface in java.sql" class="external-link"><code>JDBC connection</code></a> allows schemas to be defined |
| dynamically.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="CalciteFactory.html" title="class in org.apache.calcite.jdbc">CalciteFactory</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Extension of <code>AvaticaFactory</code> |
| for Calcite.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="CalciteJdbc41Factory.html" title="class in org.apache.calcite.jdbc">CalciteJdbc41Factory</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Implementation of <code>AvaticaFactory</code> |
| for Calcite and JDBC 4.1 (corresponds to JDK 1.7).</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="CalciteMetaImpl.html" title="class in org.apache.calcite.jdbc">CalciteMetaImpl</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Helper for implementing the <code>getXxx</code> methods such as |
| <code>AvaticaDatabaseMetaData.getTables(java.lang.String, java.lang.String, java.lang.String, java.lang.String[])</code>.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="CalcitePrepare.html" title="interface in org.apache.calcite.jdbc">CalcitePrepare</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">API for a service that prepares statements for execution.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="CalcitePrepare.AnalyzeViewResult.html" title="class in org.apache.calcite.jdbc">CalcitePrepare.AnalyzeViewResult</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">The result of analyzing a view.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="CalcitePrepare.CalciteSignature.html" title="class in org.apache.calcite.jdbc">CalcitePrepare.CalciteSignature</a><T></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">The result of preparing a query.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="CalcitePrepare.Context.html" title="interface in org.apache.calcite.jdbc">CalcitePrepare.Context</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Context for preparing a statement.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="CalcitePrepare.ConvertResult.html" title="class in org.apache.calcite.jdbc">CalcitePrepare.ConvertResult</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">The result of parsing and validating a SQL query and converting it to |
| relational algebra.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="CalcitePrepare.Dummy.html" title="class in org.apache.calcite.jdbc">CalcitePrepare.Dummy</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Namespace that allows us to define non-abstract methods inside an |
| interface.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="CalcitePrepare.ParseResult.html" title="class in org.apache.calcite.jdbc">CalcitePrepare.ParseResult</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">The result of parsing and validating a SQL query.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="CalcitePrepare.Query.html" title="class in org.apache.calcite.jdbc">CalcitePrepare.Query</a><T></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">A union type of the three possible ways of expressing a query: as a SQL |
| string, a <a href="../linq4j/Queryable.html" title="interface in org.apache.calcite.linq4j"><code>Queryable</code></a> or a <a href="../rel/RelNode.html" title="interface in org.apache.calcite.rel"><code>RelNode</code></a>.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab1"><a href="CalcitePrepare.SparkHandler.html" title="interface in org.apache.calcite.jdbc">CalcitePrepare.SparkHandler</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab1"> |
| <div class="block">Callback to register Spark as the main engine.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="CalcitePrepare.SparkHandler.RuleSetBuilder.html" title="interface in org.apache.calcite.jdbc">CalcitePrepare.SparkHandler.RuleSetBuilder</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab1"> |
| <div class="block">Allows Spark to declare the rules it needs.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="CalciteResultSet.html" title="class in org.apache.calcite.jdbc">CalciteResultSet</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Implementation of <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/java/sql/ResultSet.html" title="class or interface in java.sql" class="external-link"><code>ResultSet</code></a> |
| for the Calcite engine.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="CalciteRootSchema.html" title="class in org.apache.calcite.jdbc">CalciteRootSchema</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2">Deprecated.</div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="CalciteSchema.html" title="class in org.apache.calcite.jdbc">CalciteSchema</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Schema.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="CalciteSchema.Entry.html" title="class in org.apache.calcite.jdbc">CalciteSchema.Entry</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Entry in a schema, such as a table or sub-schema.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="CalciteSchema.FunctionEntry.html" title="class in org.apache.calcite.jdbc">CalciteSchema.FunctionEntry</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Membership of a function in a schema.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="CalciteSchema.FunctionEntryImpl.html" title="class in org.apache.calcite.jdbc">CalciteSchema.FunctionEntryImpl</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Implementation of <a href="CalciteSchema.FunctionEntry.html" title="class in org.apache.calcite.jdbc"><code>CalciteSchema.FunctionEntry</code></a> |
| where all properties are held in fields.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="CalciteSchema.LatticeEntry.html" title="class in org.apache.calcite.jdbc">CalciteSchema.LatticeEntry</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Membership of a lattice in a schema.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="CalciteSchema.LatticeEntryImpl.html" title="class in org.apache.calcite.jdbc">CalciteSchema.LatticeEntryImpl</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Implementation of <a href="CalciteSchema.LatticeEntry.html" title="class in org.apache.calcite.jdbc"><code>CalciteSchema.LatticeEntry</code></a> |
| where all properties are held in fields.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="CalciteSchema.TableEntry.html" title="class in org.apache.calcite.jdbc">CalciteSchema.TableEntry</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Membership of a table in a schema.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="CalciteSchema.TableEntryImpl.html" title="class in org.apache.calcite.jdbc">CalciteSchema.TableEntryImpl</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Implementation of <a href="CalciteSchema.TableEntry.html" title="class in org.apache.calcite.jdbc"><code>CalciteSchema.TableEntry</code></a> |
| where all properties are held in fields.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="CalciteSchema.TypeEntry.html" title="class in org.apache.calcite.jdbc">CalciteSchema.TypeEntry</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Membership of a type in a schema.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="CalciteSchema.TypeEntryImpl.html" title="class in org.apache.calcite.jdbc">CalciteSchema.TypeEntryImpl</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Implementation of <a href="CalciteSchema.TypeEntry.html" title="class in org.apache.calcite.jdbc"><code>CalciteSchema.TypeEntry</code></a> |
| where all properties are held in fields.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="CalciteStatement.html" title="class in org.apache.calcite.jdbc">CalciteStatement</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Implementation of <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.sql/java/sql/Statement.html" title="class or interface in java.sql" class="external-link"><code>Statement</code></a> |
| for the Calcite engine.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ContextSqlValidator.html" title="class in org.apache.calcite.jdbc">ContextSqlValidator</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">A SqlValidator with schema and type factory of the given |
| <a href="CalcitePrepare.Context.html" title="interface in org.apache.calcite.jdbc"><code>CalcitePrepare.Context</code></a>.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="Driver.html" title="class in org.apache.calcite.jdbc">Driver</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Calcite JDBC driver.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="JavaCollation.html" title="class in org.apache.calcite.jdbc">JavaCollation</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Collation that uses a specific <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/text/Collator.html" title="class or interface in java.text" class="external-link"><code>Collator</code></a> for comparison.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="JavaRecordType.html" title="class in org.apache.calcite.jdbc">JavaRecordType</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Record type based on a Java class.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="JavaTypeFactoryImpl.html" title="class in org.apache.calcite.jdbc">JavaTypeFactoryImpl</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab2"> |
| <div class="block">Implementation of <a href="../adapter/java/JavaTypeFactory.html" title="interface in org.apache.calcite.adapter.java"><code>JavaTypeFactory</code></a>.</div> |
| </div> |
| <div class="col-first even-row-color class-summary class-summary-tab2"><a href="JavaTypeFactoryImpl.SyntheticRecordType.html" title="class in org.apache.calcite.jdbc">JavaTypeFactoryImpl.SyntheticRecordType</a></div> |
| <div class="col-last even-row-color class-summary class-summary-tab2"> |
| <div class="block">Synthetic record type.</div> |
| </div> |
| <div class="col-first odd-row-color class-summary class-summary-tab5"><a href="SqlTimeoutException.html" title="class in org.apache.calcite.jdbc">SqlTimeoutException</a></div> |
| <div class="col-last odd-row-color class-summary class-summary-tab5"> |
| <div class="block">Indicates that an operation timed out.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </li> |
| </ul> |
| </section> |
| </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> |
