blob: 190077749f43b9a5a9d304a5b769f21342254f32 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>ProtobufMeta (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="ProtobufMeta (Apache Calcite Avatica API)";
}
}
catch(err) {
}
//-->
var data = {"i0":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/ProtobufMeta.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><a href="#nested.class.summary">Nested</a>&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.remote</a></div>
<h2 title="Interface ProtobufMeta" class="title">Interface ProtobufMeta</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><code><a href="../Meta.html" title="interface in org.apache.calcite.avatica">Meta</a></code></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="../jdbc/JdbcMeta.html" title="class in org.apache.calcite.avatica.jdbc">JdbcMeta</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">ProtobufMeta</span>
extends <a href="../Meta.html" title="interface in org.apache.calcite.avatica">Meta</a></pre>
<div class="block">An extension of <a href="../Meta.html" title="interface in org.apache.calcite.avatica"><code>Meta</code></a> which allows for native processing of calls with the Protobuf
API objects instead of the POJOS (to avoid object translation). In the write-path, performing
this conversion tends to represent a signficant portion of execution time. The introduction
of this interface is to serve the purose of gradual migration to Meta implementations that
can naturally function over Protobuf objects instead of the POJOs.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="nested.classes.inherited.from.class.org.apache.calcite.avatica.Meta">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.apache.calcite.avatica.<a href="../Meta.html" title="interface in org.apache.calcite.avatica">Meta</a></h3>
<code><a href="../Meta.ConnectionHandle.html" title="class in org.apache.calcite.avatica">Meta.ConnectionHandle</a>, <a href="../Meta.ConnectionProperties.html" title="interface in org.apache.calcite.avatica">Meta.ConnectionProperties</a>, <a href="../Meta.CursorFactory.html" title="class in org.apache.calcite.avatica">Meta.CursorFactory</a>, <a href="../Meta.DatabaseProperty.html" title="enum in org.apache.calcite.avatica">Meta.DatabaseProperty</a>, <a href="../Meta.ExecuteBatchResult.html" title="class in org.apache.calcite.avatica">Meta.ExecuteBatchResult</a>, <a href="../Meta.ExecuteResult.html" title="class in org.apache.calcite.avatica">Meta.ExecuteResult</a>, <a href="../Meta.Factory.html" title="interface in org.apache.calcite.avatica">Meta.Factory</a>, <a href="../Meta.Frame.html" title="class in org.apache.calcite.avatica">Meta.Frame</a>, <a href="../Meta.MetaResultSet.html" title="class in org.apache.calcite.avatica">Meta.MetaResultSet</a>, <a href="../Meta.Pat.html" title="class in org.apache.calcite.avatica">Meta.Pat</a>, <a href="../Meta.PrepareCallback.html" title="interface in org.apache.calcite.avatica">Meta.PrepareCallback</a>, <a href="../Meta.Signature.html" title="class in org.apache.calcite.avatica">Meta.Signature</a>, <a href="../Meta.StatementHandle.html" title="class in org.apache.calcite.avatica">Meta.StatementHandle</a>, <a href="../Meta.StatementType.html" title="enum in org.apache.calcite.avatica">Meta.StatementType</a>, <a href="../Meta.Style.html" title="enum in org.apache.calcite.avatica">Meta.Style</a></code></li>
</ul>
</li>
</ul>
</section>
<!-- ========== 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><a href="../Meta.ExecuteBatchResult.html" title="class in org.apache.calcite.avatica">Meta.ExecuteBatchResult</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#executeBatchProtobuf(org.apache.calcite.avatica.Meta.StatementHandle,java.util.List)">executeBatchProtobuf</a></span>&#8203;(<a href="../Meta.StatementHandle.html" title="class in org.apache.calcite.avatica">Meta.StatementHandle</a>&nbsp;h,
java.util.List&lt;<a href="../proto/Requests.UpdateBatch.html" title="class in org.apache.calcite.avatica.proto">Requests.UpdateBatch</a>&gt;&nbsp;parameterValues)</code></th>
<td class="colLast">
<div class="block">Executes a batch of commands on a prepared statement.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.calcite.avatica.Meta">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.calcite.avatica.<a href="../Meta.html" title="interface in org.apache.calcite.avatica">Meta</a></h3>
<code><a href="../Meta.html#closeConnection(org.apache.calcite.avatica.Meta.ConnectionHandle)">closeConnection</a>, <a href="../Meta.html#closeStatement(org.apache.calcite.avatica.Meta.StatementHandle)">closeStatement</a>, <a href="../Meta.html#commit(org.apache.calcite.avatica.Meta.ConnectionHandle)">commit</a>, <a href="../Meta.html#connectionSync(org.apache.calcite.avatica.Meta.ConnectionHandle,org.apache.calcite.avatica.Meta.ConnectionProperties)">connectionSync</a>, <a href="../Meta.html#createIterable(org.apache.calcite.avatica.Meta.StatementHandle,org.apache.calcite.avatica.QueryState,org.apache.calcite.avatica.Meta.Signature,java.util.List,org.apache.calcite.avatica.Meta.Frame)">createIterable</a>, <a href="../Meta.html#createStatement(org.apache.calcite.avatica.Meta.ConnectionHandle)">createStatement</a>, <a href="../Meta.html#execute(org.apache.calcite.avatica.Meta.StatementHandle,java.util.List,int)">execute</a>, <a href="../Meta.html#execute(org.apache.calcite.avatica.Meta.StatementHandle,java.util.List,long)">execute</a>, <a href="../Meta.html#executeBatch(org.apache.calcite.avatica.Meta.StatementHandle,java.util.List)">executeBatch</a>, <a href="../Meta.html#fetch(org.apache.calcite.avatica.Meta.StatementHandle,long,int)">fetch</a>, <a href="../Meta.html#getAttributes(org.apache.calcite.avatica.Meta.ConnectionHandle,java.lang.String,org.apache.calcite.avatica.Meta.Pat,org.apache.calcite.avatica.Meta.Pat,org.apache.calcite.avatica.Meta.Pat)">getAttributes</a>, <a href="../Meta.html#getBestRowIdentifier(org.apache.calcite.avatica.Meta.ConnectionHandle,java.lang.String,java.lang.String,java.lang.String,int,boolean)">getBestRowIdentifier</a>, <a href="../Meta.html#getCatalogs(org.apache.calcite.avatica.Meta.ConnectionHandle)">getCatalogs</a>, <a href="../Meta.html#getClientInfoProperties(org.apache.calcite.avatica.Meta.ConnectionHandle)">getClientInfoProperties</a>, <a href="../Meta.html#getColumnPrivileges(org.apache.calcite.avatica.Meta.ConnectionHandle,java.lang.String,java.lang.String,java.lang.String,org.apache.calcite.avatica.Meta.Pat)">getColumnPrivileges</a>, <a href="../Meta.html#getColumns(org.apache.calcite.avatica.Meta.ConnectionHandle,java.lang.String,org.apache.calcite.avatica.Meta.Pat,org.apache.calcite.avatica.Meta.Pat,org.apache.calcite.avatica.Meta.Pat)">getColumns</a>, <a href="../Meta.html#getCrossReference(org.apache.calcite.avatica.Meta.ConnectionHandle,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String)">getCrossReference</a>, <a href="../Meta.html#getDatabaseProperties(org.apache.calcite.avatica.Meta.ConnectionHandle)">getDatabaseProperties</a>, <a href="../Meta.html#getExportedKeys(org.apache.calcite.avatica.Meta.ConnectionHandle,java.lang.String,java.lang.String,java.lang.String)">getExportedKeys</a>, <a href="../Meta.html#getFunctionColumns(org.apache.calcite.avatica.Meta.ConnectionHandle,java.lang.String,org.apache.calcite.avatica.Meta.Pat,org.apache.calcite.avatica.Meta.Pat,org.apache.calcite.avatica.Meta.Pat)">getFunctionColumns</a>, <a href="../Meta.html#getFunctions(org.apache.calcite.avatica.Meta.ConnectionHandle,java.lang.String,org.apache.calcite.avatica.Meta.Pat,org.apache.calcite.avatica.Meta.Pat)">getFunctions</a>, <a href="../Meta.html#getImportedKeys(org.apache.calcite.avatica.Meta.ConnectionHandle,java.lang.String,java.lang.String,java.lang.String)">getImportedKeys</a>, <a href="../Meta.html#getIndexInfo(org.apache.calcite.avatica.Meta.ConnectionHandle,java.lang.String,java.lang.String,java.lang.String,boolean,boolean)">getIndexInfo</a>, <a href="../Meta.html#getPrimaryKeys(org.apache.calcite.avatica.Meta.ConnectionHandle,java.lang.String,java.lang.String,java.lang.String)">getPrimaryKeys</a>, <a href="../Meta.html#getProcedureColumns(org.apache.calcite.avatica.Meta.ConnectionHandle,java.lang.String,org.apache.calcite.avatica.Meta.Pat,org.apache.calcite.avatica.Meta.Pat,org.apache.calcite.avatica.Meta.Pat)">getProcedureColumns</a>, <a href="../Meta.html#getProcedures(org.apache.calcite.avatica.Meta.ConnectionHandle,java.lang.String,org.apache.calcite.avatica.Meta.Pat,org.apache.calcite.avatica.Meta.Pat)">getProcedures</a>, <a href="../Meta.html#getPseudoColumns(org.apache.calcite.avatica.Meta.ConnectionHandle,java.lang.String,org.apache.calcite.avatica.Meta.Pat,org.apache.calcite.avatica.Meta.Pat,org.apache.calcite.avatica.Meta.Pat)">getPseudoColumns</a>, <a href="../Meta.html#getSchemas(org.apache.calcite.avatica.Meta.ConnectionHandle,java.lang.String,org.apache.calcite.avatica.Meta.Pat)">getSchemas</a>, <a href="../Meta.html#getSuperTables(org.apache.calcite.avatica.Meta.ConnectionHandle,java.lang.String,org.apache.calcite.avatica.Meta.Pat,org.apache.calcite.avatica.Meta.Pat)">getSuperTables</a>, <a href="../Meta.html#getSuperTypes(org.apache.calcite.avatica.Meta.ConnectionHandle,java.lang.String,org.apache.calcite.avatica.Meta.Pat,org.apache.calcite.avatica.Meta.Pat)">getSuperTypes</a>, <a href="../Meta.html#getTablePrivileges(org.apache.calcite.avatica.Meta.ConnectionHandle,java.lang.String,org.apache.calcite.avatica.Meta.Pat,org.apache.calcite.avatica.Meta.Pat)">getTablePrivileges</a>, <a href="../Meta.html#getTables(org.apache.calcite.avatica.Meta.ConnectionHandle,java.lang.String,org.apache.calcite.avatica.Meta.Pat,org.apache.calcite.avatica.Meta.Pat,java.util.List)">getTables</a>, <a href="../Meta.html#getTableTypes(org.apache.calcite.avatica.Meta.ConnectionHandle)">getTableTypes</a>, <a href="../Meta.html#getTypeInfo(org.apache.calcite.avatica.Meta.ConnectionHandle)">getTypeInfo</a>, <a href="../Meta.html#getUDTs(org.apache.calcite.avatica.Meta.ConnectionHandle,java.lang.String,org.apache.calcite.avatica.Meta.Pat,org.apache.calcite.avatica.Meta.Pat,int%5B%5D)">getUDTs</a>, <a href="../Meta.html#getVersionColumns(org.apache.calcite.avatica.Meta.ConnectionHandle,java.lang.String,java.lang.String,java.lang.String)">getVersionColumns</a>, <a href="../Meta.html#openConnection(org.apache.calcite.avatica.Meta.ConnectionHandle,java.util.Map)">openConnection</a>, <a href="../Meta.html#prepare(org.apache.calcite.avatica.Meta.ConnectionHandle,java.lang.String,long)">prepare</a>, <a href="../Meta.html#prepareAndExecute(org.apache.calcite.avatica.Meta.StatementHandle,java.lang.String,long,int,org.apache.calcite.avatica.Meta.PrepareCallback)">prepareAndExecute</a>, <a href="../Meta.html#prepareAndExecute(org.apache.calcite.avatica.Meta.StatementHandle,java.lang.String,long,org.apache.calcite.avatica.Meta.PrepareCallback)">prepareAndExecute</a>, <a href="../Meta.html#prepareAndExecuteBatch(org.apache.calcite.avatica.Meta.StatementHandle,java.util.List)">prepareAndExecuteBatch</a>, <a href="../Meta.html#rollback(org.apache.calcite.avatica.Meta.ConnectionHandle)">rollback</a>, <a href="../Meta.html#syncResults(org.apache.calcite.avatica.Meta.StatementHandle,org.apache.calcite.avatica.QueryState,long)">syncResults</a></code></li>
</ul>
</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="executeBatchProtobuf(org.apache.calcite.avatica.Meta.StatementHandle,java.util.List)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>executeBatchProtobuf</h4>
<pre class="methodSignature"><a href="../Meta.ExecuteBatchResult.html" title="class in org.apache.calcite.avatica">Meta.ExecuteBatchResult</a>&nbsp;executeBatchProtobuf&#8203;(<a href="../Meta.StatementHandle.html" title="class in org.apache.calcite.avatica">Meta.StatementHandle</a>&nbsp;h,
java.util.List&lt;<a href="../proto/Requests.UpdateBatch.html" title="class in org.apache.calcite.avatica.proto">Requests.UpdateBatch</a>&gt;&nbsp;parameterValues)
throws <a href="../NoSuchStatementException.html" title="class in org.apache.calcite.avatica">NoSuchStatementException</a></pre>
<div class="block">Executes a batch of commands on a prepared statement.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>h</code> - Statement handle</dd>
<dd><code>parameterValues</code> - A collection of list of typed values, one list per batch</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An array of update counts containing one element for each command in the batch.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../NoSuchStatementException.html" title="class in org.apache.calcite.avatica">NoSuchStatementException</a></code></dd>
</dl>
</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/ProtobufMeta.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><a href="#nested.class.summary">Nested</a>&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>