blob: b5c577a39832782f948ec5d69a7a1651ca3f80e9 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Meta.ConnectionProperties (Apache Calcite Avatica API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Meta.ConnectionProperties (Apache Calcite Avatica API)";
}
}
catch(err) {
}
//-->
var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":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 = "../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= 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="class-use/Meta.ConnectionProperties.html">Use</a></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>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.calcite.avatica</a></div>
<h2 title="Interface Meta.ConnectionProperties" class="title">Interface Meta.ConnectionProperties</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<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>
<dt>Enclosing interface:</dt>
<dd><a href="Meta.html" title="interface in org.apache.calcite.avatica">Meta</a></dd>
</dl>
<hr>
<pre>public static interface <span class="typeNameLabel">Meta.ConnectionProperties</span></pre>
<div class="block">A pojo containing various client-settable <code>Connection</code> 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
<code>Connection</code>, <code>Statement</code>, and <code>ResultSet</code>.</p></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<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>
<tr id="i0" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCatalog()">getCatalog</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSchema()">getSchema</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.lang.Integer</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTransactionIsolation()">getTransactionIsolation</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.lang.Boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isAutoCommit()">isAutoCommit</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isEmpty()">isEmpty</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.lang.Boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isReadOnly()">isReadOnly</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="Meta.ConnectionProperties.html" title="interface in org.apache.calcite.avatica">Meta.ConnectionProperties</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#merge(org.apache.calcite.avatica.Meta.ConnectionProperties)">merge</a></span>&#8203;(<a href="Meta.ConnectionProperties.html" title="interface in org.apache.calcite.avatica">Meta.ConnectionProperties</a>&nbsp;that)</code></th>
<td class="colLast">
<div class="block">Overwrite fields in <code>this</code> with any non-null fields in <code>that</code></div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="Meta.ConnectionProperties.html" title="interface in org.apache.calcite.avatica">Meta.ConnectionProperties</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setAutoCommit(boolean)">setAutoCommit</a></span>&#8203;(boolean&nbsp;val)</code></th>
<td class="colLast">
<div class="block">Set <code>autoCommit</code> status.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="Meta.ConnectionProperties.html" title="interface in org.apache.calcite.avatica">Meta.ConnectionProperties</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setCatalog(java.lang.String)">setCatalog</a></span>&#8203;(java.lang.String&nbsp;val)</code></th>
<td class="colLast">
<div class="block">Set <code>catalog</code>.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="Meta.ConnectionProperties.html" title="interface in org.apache.calcite.avatica">Meta.ConnectionProperties</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setReadOnly(boolean)">setReadOnly</a></span>&#8203;(boolean&nbsp;val)</code></th>
<td class="colLast">
<div class="block">Set <code>readOnly</code> status.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="Meta.ConnectionProperties.html" title="interface in org.apache.calcite.avatica">Meta.ConnectionProperties</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSchema(java.lang.String)">setSchema</a></span>&#8203;(java.lang.String&nbsp;val)</code></th>
<td class="colLast">
<div class="block">Set <code>schema</code>.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="Meta.ConnectionProperties.html" title="interface in org.apache.calcite.avatica">Meta.ConnectionProperties</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setTransactionIsolation(int)">setTransactionIsolation</a></span>&#8203;(int&nbsp;val)</code></th>
<td class="colLast">
<div class="block">Set <code>transactionIsolation</code> status.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="proto/Common.ConnectionProperties.html" title="class in org.apache.calcite.avatica.proto">Common.ConnectionProperties</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toProto()">toProto</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="merge(org.apache.calcite.avatica.Meta.ConnectionProperties)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>merge</h4>
<pre class="methodSignature"><a href="Meta.ConnectionProperties.html" title="interface in org.apache.calcite.avatica">Meta.ConnectionProperties</a>&nbsp;merge&#8203;(<a href="Meta.ConnectionProperties.html" title="interface in org.apache.calcite.avatica">Meta.ConnectionProperties</a>&nbsp;that)</pre>
<div class="block">Overwrite fields in <code>this</code> with any non-null fields in <code>that</code></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>this</code></dd>
</dl>
</li>
</ul>
<a id="isEmpty()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEmpty</h4>
<pre class="methodSignature">boolean&nbsp;isEmpty()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> when no properties have been set, <code>false</code> otherwise.</dd>
</dl>
</li>
</ul>
<a id="setAutoCommit(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAutoCommit</h4>
<pre class="methodSignature"><a href="Meta.ConnectionProperties.html" title="interface in org.apache.calcite.avatica">Meta.ConnectionProperties</a>&nbsp;setAutoCommit&#8203;(boolean&nbsp;val)</pre>
<div class="block">Set <code>autoCommit</code> status.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>this</code></dd>
</dl>
</li>
</ul>
<a id="isAutoCommit()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAutoCommit</h4>
<pre class="methodSignature">java.lang.Boolean&nbsp;isAutoCommit()</pre>
</li>
</ul>
<a id="setReadOnly(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setReadOnly</h4>
<pre class="methodSignature"><a href="Meta.ConnectionProperties.html" title="interface in org.apache.calcite.avatica">Meta.ConnectionProperties</a>&nbsp;setReadOnly&#8203;(boolean&nbsp;val)</pre>
<div class="block">Set <code>readOnly</code> status.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>this</code></dd>
</dl>
</li>
</ul>
<a id="isReadOnly()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isReadOnly</h4>
<pre class="methodSignature">java.lang.Boolean&nbsp;isReadOnly()</pre>
</li>
</ul>
<a id="setTransactionIsolation(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTransactionIsolation</h4>
<pre class="methodSignature"><a href="Meta.ConnectionProperties.html" title="interface in org.apache.calcite.avatica">Meta.ConnectionProperties</a>&nbsp;setTransactionIsolation&#8203;(int&nbsp;val)</pre>
<div class="block">Set <code>transactionIsolation</code> status.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>this</code></dd>
</dl>
</li>
</ul>
<a id="getTransactionIsolation()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTransactionIsolation</h4>
<pre class="methodSignature">java.lang.Integer&nbsp;getTransactionIsolation()</pre>
</li>
</ul>
<a id="setCatalog(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCatalog</h4>
<pre class="methodSignature"><a href="Meta.ConnectionProperties.html" title="interface in org.apache.calcite.avatica">Meta.ConnectionProperties</a>&nbsp;setCatalog&#8203;(java.lang.String&nbsp;val)</pre>
<div class="block">Set <code>catalog</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>this</code></dd>
</dl>
</li>
</ul>
<a id="getCatalog()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCatalog</h4>
<pre class="methodSignature">java.lang.String&nbsp;getCatalog()</pre>
</li>
</ul>
<a id="setSchema(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSchema</h4>
<pre class="methodSignature"><a href="Meta.ConnectionProperties.html" title="interface in org.apache.calcite.avatica">Meta.ConnectionProperties</a>&nbsp;setSchema&#8203;(java.lang.String&nbsp;val)</pre>
<div class="block">Set <code>schema</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>this</code></dd>
</dl>
</li>
</ul>
<a id="getSchema()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSchema</h4>
<pre class="methodSignature">java.lang.String&nbsp;getSchema()</pre>
</li>
</ul>
<a id="toProto()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toProto</h4>
<pre class="methodSignature"><a href="proto/Common.ConnectionProperties.html" title="class in org.apache.calcite.avatica.proto">Common.ConnectionProperties</a>&nbsp;toProto()</pre>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<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="class-use/Meta.ConnectionProperties.html">Use</a></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>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2012&#x2013;2019 <a href="https://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>