| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>AvaticaFactory (Apache Calcite Avatica 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.avatica, interface: AvaticaFactory"> |
| <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 Avatica</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.avatica</a></div> |
| <h1 title="Interface AvaticaFactory" class="title">Interface AvaticaFactory</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">AvaticaFactory</span></div> |
| <div class="block">Factory for JDBC objects. |
| |
| <p>There is an implementation for each supported JDBC version.</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>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getJdbcMajorVersion()" class="member-name-link">getJdbcMajorVersion</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getJdbcMinorVersion()" class="member-name-link">getJdbcMinorVersion</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="AvaticaConnection.html" title="class in org.apache.calcite.avatica">AvaticaConnection</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#newConnection(org.apache.calcite.avatica.UnregisteredDriver,org.apache.calcite.avatica.AvaticaFactory,java.lang.String,java.util.Properties)" class="member-name-link">newConnection</a><wbr>(<a href="UnregisteredDriver.html" title="class in org.apache.calcite.avatica">UnregisteredDriver</a> driver, |
| <a href="AvaticaFactory.html" title="interface in org.apache.calcite.avatica">AvaticaFactory</a> factory, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> url, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html" title="class or interface in java.util" class="external-link">Properties</a> info)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="AvaticaSpecificDatabaseMetaData.html" title="interface in org.apache.calcite.avatica">AvaticaSpecificDatabaseMetaData</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#newDatabaseMetaData(org.apache.calcite.avatica.AvaticaConnection)" class="member-name-link">newDatabaseMetaData</a><wbr>(<a href="AvaticaConnection.html" title="class in org.apache.calcite.avatica">AvaticaConnection</a> connection)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Creates meta data for the database.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="AvaticaPreparedStatement.html" title="class in org.apache.calcite.avatica">AvaticaPreparedStatement</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#newPreparedStatement(org.apache.calcite.avatica.AvaticaConnection,org.apache.calcite.avatica.Meta.StatementHandle,org.apache.calcite.avatica.Meta.Signature,int,int,int)" class="member-name-link">newPreparedStatement</a><wbr>(<a href="AvaticaConnection.html" title="class in org.apache.calcite.avatica">AvaticaConnection</a> connection, |
| <a href="Meta.StatementHandle.html" title="class in org.apache.calcite.avatica">Meta.StatementHandle</a> h, |
| <a href="Meta.Signature.html" title="class in org.apache.calcite.avatica">Meta.Signature</a> signature, |
| int resultSetType, |
| int resultSetConcurrency, |
| int resultSetHoldability)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="AvaticaResultSet.html" title="class in org.apache.calcite.avatica">AvaticaResultSet</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#newResultSet(org.apache.calcite.avatica.AvaticaStatement,org.apache.calcite.avatica.QueryState,org.apache.calcite.avatica.Meta.Signature,java.util.TimeZone,org.apache.calcite.avatica.Meta.Frame)" class="member-name-link">newResultSet</a><wbr>(<a href="AvaticaStatement.html" title="class in org.apache.calcite.avatica">AvaticaStatement</a> statement, |
| <a href="QueryState.html" title="class in org.apache.calcite.avatica">QueryState</a> state, |
| <a href="Meta.Signature.html" title="class in org.apache.calcite.avatica">Meta.Signature</a> signature, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/TimeZone.html" title="class or interface in java.util" class="external-link">TimeZone</a> timeZone, |
| <a href="Meta.Frame.html" title="class in org.apache.calcite.avatica">Meta.Frame</a> firstFrame)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Creates a result set.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSetMetaData.html" title="class or interface in java.sql" class="external-link">ResultSetMetaData</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#newResultSetMetaData(org.apache.calcite.avatica.AvaticaStatement,org.apache.calcite.avatica.Meta.Signature)" class="member-name-link">newResultSetMetaData</a><wbr>(<a href="AvaticaStatement.html" title="class in org.apache.calcite.avatica">AvaticaStatement</a> statement, |
| <a href="Meta.Signature.html" title="class in org.apache.calcite.avatica">Meta.Signature</a> signature)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Creates meta data for a result set.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="AvaticaStatement.html" title="class in org.apache.calcite.avatica">AvaticaStatement</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#newStatement(org.apache.calcite.avatica.AvaticaConnection,org.apache.calcite.avatica.Meta.StatementHandle,int,int,int)" class="member-name-link">newStatement</a><wbr>(<a href="AvaticaConnection.html" title="class in org.apache.calcite.avatica">AvaticaConnection</a> connection, |
| <a href="Meta.StatementHandle.html" title="class in org.apache.calcite.avatica">Meta.StatementHandle</a> h, |
| int resultSetType, |
| int resultSetConcurrency, |
| int resultSetHoldability)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> </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="getJdbcMajorVersion()"> |
| <h3>getJdbcMajorVersion</h3> |
| <div class="member-signature"><span class="return-type">int</span> <span class="element-name">getJdbcMajorVersion</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getJdbcMinorVersion()"> |
| <h3>getJdbcMinorVersion</h3> |
| <div class="member-signature"><span class="return-type">int</span> <span class="element-name">getJdbcMinorVersion</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newConnection(org.apache.calcite.avatica.UnregisteredDriver,org.apache.calcite.avatica.AvaticaFactory,java.lang.String,java.util.Properties)"> |
| <h3>newConnection</h3> |
| <div class="member-signature"><span class="return-type"><a href="AvaticaConnection.html" title="class in org.apache.calcite.avatica">AvaticaConnection</a></span> <span class="element-name">newConnection</span><wbr><span class="parameters">(<a href="UnregisteredDriver.html" title="class in org.apache.calcite.avatica">UnregisteredDriver</a> driver, |
| <a href="AvaticaFactory.html" title="interface in org.apache.calcite.avatica">AvaticaFactory</a> factory, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> url, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html" title="class or interface in java.util" class="external-link">Properties</a> info)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html" title="class or interface in java.sql" class="external-link">SQLException</a></span></div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html" title="class or interface in java.sql" class="external-link">SQLException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newStatement(org.apache.calcite.avatica.AvaticaConnection,org.apache.calcite.avatica.Meta.StatementHandle,int,int,int)"> |
| <h3>newStatement</h3> |
| <div class="member-signature"><span class="return-type"><a href="AvaticaStatement.html" title="class in org.apache.calcite.avatica">AvaticaStatement</a></span> <span class="element-name">newStatement</span><wbr><span class="parameters">(<a href="AvaticaConnection.html" title="class in org.apache.calcite.avatica">AvaticaConnection</a> connection, |
| <a href="Meta.StatementHandle.html" title="class in org.apache.calcite.avatica">Meta.StatementHandle</a> h, |
| int resultSetType, |
| int resultSetConcurrency, |
| int resultSetHoldability)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html" title="class or interface in java.sql" class="external-link">SQLException</a></span></div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html" title="class or interface in java.sql" class="external-link">SQLException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newPreparedStatement(org.apache.calcite.avatica.AvaticaConnection,org.apache.calcite.avatica.Meta.StatementHandle,org.apache.calcite.avatica.Meta.Signature,int,int,int)"> |
| <h3>newPreparedStatement</h3> |
| <div class="member-signature"><span class="return-type"><a href="AvaticaPreparedStatement.html" title="class in org.apache.calcite.avatica">AvaticaPreparedStatement</a></span> <span class="element-name">newPreparedStatement</span><wbr><span class="parameters">(<a href="AvaticaConnection.html" title="class in org.apache.calcite.avatica">AvaticaConnection</a> connection, |
| <a href="Meta.StatementHandle.html" title="class in org.apache.calcite.avatica">Meta.StatementHandle</a> h, |
| <a href="Meta.Signature.html" title="class in org.apache.calcite.avatica">Meta.Signature</a> signature, |
| int resultSetType, |
| int resultSetConcurrency, |
| int resultSetHoldability)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html" title="class or interface in java.sql" class="external-link">SQLException</a></span></div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html" title="class or interface in java.sql" class="external-link">SQLException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newResultSet(org.apache.calcite.avatica.AvaticaStatement,org.apache.calcite.avatica.QueryState,org.apache.calcite.avatica.Meta.Signature,java.util.TimeZone,org.apache.calcite.avatica.Meta.Frame)"> |
| <h3>newResultSet</h3> |
| <div class="member-signature"><span class="return-type"><a href="AvaticaResultSet.html" title="class in org.apache.calcite.avatica">AvaticaResultSet</a></span> <span class="element-name">newResultSet</span><wbr><span class="parameters">(<a href="AvaticaStatement.html" title="class in org.apache.calcite.avatica">AvaticaStatement</a> statement, |
| <a href="QueryState.html" title="class in org.apache.calcite.avatica">QueryState</a> state, |
| <a href="Meta.Signature.html" title="class in org.apache.calcite.avatica">Meta.Signature</a> signature, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/TimeZone.html" title="class or interface in java.util" class="external-link">TimeZone</a> timeZone, |
| <a href="Meta.Frame.html" title="class in org.apache.calcite.avatica">Meta.Frame</a> firstFrame)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html" title="class or interface in java.sql" class="external-link">SQLException</a></span></div> |
| <div class="block">Creates a result set. You will then need to call |
| <a href="AvaticaResultSet.html#execute()"><code>AvaticaResultSet.execute()</code></a> on it.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>statement</code> - Statement</dd> |
| <dd><code>state</code> - The state used to create this result set</dd> |
| <dd><code>signature</code> - Prepared statement</dd> |
| <dd><code>timeZone</code> - Time zone</dd> |
| <dd><code>firstFrame</code> - Frame containing the first (or perhaps only) rows in the |
| result, or null if an execute/fetch is required</dd> |
| <dt>Returns:</dt> |
| <dd>Result set</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html" title="class or interface in java.sql" class="external-link">SQLException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newDatabaseMetaData(org.apache.calcite.avatica.AvaticaConnection)"> |
| <h3>newDatabaseMetaData</h3> |
| <div class="member-signature"><span class="return-type"><a href="AvaticaSpecificDatabaseMetaData.html" title="interface in org.apache.calcite.avatica">AvaticaSpecificDatabaseMetaData</a></span> <span class="element-name">newDatabaseMetaData</span><wbr><span class="parameters">(<a href="AvaticaConnection.html" title="class in org.apache.calcite.avatica">AvaticaConnection</a> connection)</span></div> |
| <div class="block">Creates meta data for the database.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>Database meta data</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newResultSetMetaData(org.apache.calcite.avatica.AvaticaStatement,org.apache.calcite.avatica.Meta.Signature)"> |
| <h3>newResultSetMetaData</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSetMetaData.html" title="class or interface in java.sql" class="external-link">ResultSetMetaData</a></span> <span class="element-name">newResultSetMetaData</span><wbr><span class="parameters">(<a href="AvaticaStatement.html" title="class in org.apache.calcite.avatica">AvaticaStatement</a> statement, |
| <a href="Meta.Signature.html" title="class in org.apache.calcite.avatica">Meta.Signature</a> signature)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html" title="class or interface in java.sql" class="external-link">SQLException</a></span></div> |
| <div class="block">Creates meta data for a result set.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>statement</code> - Statement</dd> |
| <dd><code>signature</code> - Prepared statement</dd> |
| <dt>Returns:</dt> |
| <dd>Result set meta data</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html" title="class or interface in java.sql" class="external-link">SQLException</a></code></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> |