| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Meta.ConnectionProperties (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: Meta, interface: ConnectionProperties"> |
| <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 Meta.ConnectionProperties" class="title">Interface Meta.ConnectionProperties</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="ConnectionPropertiesImpl.html" title="class in org.apache.calcite.avatica">ConnectionPropertiesImpl</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>Enclosing interface:</dt> |
| <dd><a href="Meta.html" title="interface in org.apache.calcite.avatica">Meta</a></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public static interface </span><span class="element-name type-name-label">Meta.ConnectionProperties</span></div> |
| <div class="block">A pojo containing various client-settable <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/Connection.html" title="class or interface in java.sql" class="external-link"><code>Connection</code></a> properties. |
| |
| <p><code>java.lang</code> types are used here so that <code>null</code> can be used to indicate |
| a value has no been set.</p> |
| |
| <p>Note: this interface is considered "experimental" and may undergo further changes as this |
| functionality is extended to other aspects of state management for |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/Connection.html" title="class or interface in java.sql" class="external-link"><code>Connection</code></a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/Statement.html" title="class or interface in java.sql" class="external-link"><code>Statement</code></a>, and <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/ResultSet.html" title="class or interface in java.sql" class="external-link"><code>ResultSet</code></a>.</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><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></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getCatalog()" class="member-name-link">getCatalog</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><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></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getSchema()" class="member-name-link">getSchema</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="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getTransactionIsolation()" class="member-name-link">getTransactionIsolation</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><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isAutoCommit()" class="member-name-link">isAutoCommit</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>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isEmpty()" class="member-name-link">isEmpty</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><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isReadOnly()" class="member-name-link">isReadOnly</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="Meta.ConnectionProperties.html" title="interface in org.apache.calcite.avatica">Meta.ConnectionProperties</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#merge(org.apache.calcite.avatica.Meta.ConnectionProperties)" class="member-name-link">merge</a><wbr>(<a href="Meta.ConnectionProperties.html" title="interface in org.apache.calcite.avatica">Meta.ConnectionProperties</a> that)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Overwrite fields in <code>this</code> with any non-null fields in <code>that</code></div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Meta.ConnectionProperties.html" title="interface in org.apache.calcite.avatica">Meta.ConnectionProperties</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setAutoCommit(boolean)" class="member-name-link">setAutoCommit</a><wbr>(boolean val)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Set <code>autoCommit</code> status.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Meta.ConnectionProperties.html" title="interface in org.apache.calcite.avatica">Meta.ConnectionProperties</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setCatalog(java.lang.String)" class="member-name-link">setCatalog</a><wbr>(<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> val)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Set <code>catalog</code>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Meta.ConnectionProperties.html" title="interface in org.apache.calcite.avatica">Meta.ConnectionProperties</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setReadOnly(boolean)" class="member-name-link">setReadOnly</a><wbr>(boolean val)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Set <code>readOnly</code> status.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Meta.ConnectionProperties.html" title="interface in org.apache.calcite.avatica">Meta.ConnectionProperties</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setSchema(java.lang.String)" class="member-name-link">setSchema</a><wbr>(<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> val)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Set <code>schema</code>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="Meta.ConnectionProperties.html" title="interface in org.apache.calcite.avatica">Meta.ConnectionProperties</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setTransactionIsolation(int)" class="member-name-link">setTransactionIsolation</a><wbr>(int val)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Set <code>transactionIsolation</code> status.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>org.apache.calcite.avatica.proto.Common.ConnectionProperties</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#toProto()" class="member-name-link">toProto</a>()</code></div> |
| <div class="col-last even-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="merge(org.apache.calcite.avatica.Meta.ConnectionProperties)"> |
| <h3>merge</h3> |
| <div class="member-signature"><span class="return-type"><a href="Meta.ConnectionProperties.html" title="interface in org.apache.calcite.avatica">Meta.ConnectionProperties</a></span> <span class="element-name">merge</span><wbr><span class="parameters">(<a href="Meta.ConnectionProperties.html" title="interface in org.apache.calcite.avatica">Meta.ConnectionProperties</a> that)</span></div> |
| <div class="block">Overwrite fields in <code>this</code> with any non-null fields in <code>that</code></div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd><code>this</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isEmpty()"> |
| <h3>isEmpty</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isEmpty</span>()</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd><code>true</code> when no properties have been set, <code>false</code> otherwise.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setAutoCommit(boolean)"> |
| <h3>setAutoCommit</h3> |
| <div class="member-signature"><span class="return-type"><a href="Meta.ConnectionProperties.html" title="interface in org.apache.calcite.avatica">Meta.ConnectionProperties</a></span> <span class="element-name">setAutoCommit</span><wbr><span class="parameters">(boolean val)</span></div> |
| <div class="block">Set <code>autoCommit</code> status.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd><code>this</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isAutoCommit()"> |
| <h3>isAutoCommit</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a></span> <span class="element-name">isAutoCommit</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setReadOnly(boolean)"> |
| <h3>setReadOnly</h3> |
| <div class="member-signature"><span class="return-type"><a href="Meta.ConnectionProperties.html" title="interface in org.apache.calcite.avatica">Meta.ConnectionProperties</a></span> <span class="element-name">setReadOnly</span><wbr><span class="parameters">(boolean val)</span></div> |
| <div class="block">Set <code>readOnly</code> status.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd><code>this</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isReadOnly()"> |
| <h3>isReadOnly</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a></span> <span class="element-name">isReadOnly</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setTransactionIsolation(int)"> |
| <h3>setTransactionIsolation</h3> |
| <div class="member-signature"><span class="return-type"><a href="Meta.ConnectionProperties.html" title="interface in org.apache.calcite.avatica">Meta.ConnectionProperties</a></span> <span class="element-name">setTransactionIsolation</span><wbr><span class="parameters">(int val)</span></div> |
| <div class="block">Set <code>transactionIsolation</code> status.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd><code>this</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTransactionIsolation()"> |
| <h3>getTransactionIsolation</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a></span> <span class="element-name">getTransactionIsolation</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setCatalog(java.lang.String)"> |
| <h3>setCatalog</h3> |
| <div class="member-signature"><span class="return-type"><a href="Meta.ConnectionProperties.html" title="interface in org.apache.calcite.avatica">Meta.ConnectionProperties</a></span> <span class="element-name">setCatalog</span><wbr><span class="parameters">(<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> val)</span></div> |
| <div class="block">Set <code>catalog</code>.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd><code>this</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getCatalog()"> |
| <h3>getCatalog</h3> |
| <div class="member-signature"><span class="return-type"><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></span> <span class="element-name">getCatalog</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setSchema(java.lang.String)"> |
| <h3>setSchema</h3> |
| <div class="member-signature"><span class="return-type"><a href="Meta.ConnectionProperties.html" title="interface in org.apache.calcite.avatica">Meta.ConnectionProperties</a></span> <span class="element-name">setSchema</span><wbr><span class="parameters">(<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> val)</span></div> |
| <div class="block">Set <code>schema</code>.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd><code>this</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSchema()"> |
| <h3>getSchema</h3> |
| <div class="member-signature"><span class="return-type"><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></span> <span class="element-name">getSchema</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toProto()"> |
| <h3>toProto</h3> |
| <div class="member-signature"><span class="return-type">org.apache.calcite.avatica.proto.Common.ConnectionProperties</span> <span class="element-name">toProto</span>()</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> |
