You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@calcite.apache.org by jh...@apache.org on 2015/09/30 20:33:54 UTC
svn commit: r1706118 [1/3] - /incubator/calcite/site/docs/
Author: jhyde
Date: Wed Sep 30 18:33:53 2015
New Revision: 1706118
URL: http://svn.apache.org/viewvc?rev=1706118&view=rev
Log:
Update Calcite site for [CALCITE-866] Avatica and [CALCITE-828] Algebra
Added:
incubator/calcite/site/docs/avatica_json_reference.html
incubator/calcite/site/docs/avatica_overview.html
incubator/calcite/site/docs/avatica_roadmap.html
Removed:
incubator/calcite/site/docs/avatica.html
Modified:
incubator/calcite/site/docs/adapter.html
incubator/calcite/site/docs/algebra.html
incubator/calcite/site/docs/contributing.html
incubator/calcite/site/docs/downloads.html
incubator/calcite/site/docs/history.html
incubator/calcite/site/docs/howto.html
incubator/calcite/site/docs/index.html
incubator/calcite/site/docs/lattice.html
incubator/calcite/site/docs/model.html
incubator/calcite/site/docs/reference.html
incubator/calcite/site/docs/stream.html
incubator/calcite/site/docs/tutorial.html
Modified: incubator/calcite/site/docs/adapter.html
URL: http://svn.apache.org/viewvc/incubator/calcite/site/docs/adapter.html?rev=1706118&r1=1706117&r2=1706118&view=diff
==============================================================================
--- incubator/calcite/site/docs/adapter.html (original)
+++ incubator/calcite/site/docs/adapter.html Wed Sep 30 18:33:53 2015
@@ -118,6 +118,10 @@
+
+
+
+
@@ -150,6 +154,10 @@
+
+
+
+
@@ -182,6 +190,10 @@
+
+
+
+
</optgroup>
@@ -221,6 +233,89 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ </optgroup>
+
+ <optgroup label="Avatica">
+
+
@@ -253,6 +348,10 @@
+
+
+
+
@@ -285,6 +384,10 @@
+
+
+
+
@@ -317,6 +420,10 @@
+
+
+
+
</optgroup>
@@ -356,6 +463,10 @@
+
+
+
+
@@ -388,6 +499,10 @@
+
+
+
+
@@ -420,6 +535,10 @@
+
+
+
+
</optgroup>
@@ -459,6 +578,10 @@
+
+
+
+
@@ -491,6 +614,10 @@
+
+
+
+
@@ -523,6 +650,10 @@
+
+
+
+
@@ -555,6 +686,10 @@
+
+
+
+
</optgroup>
@@ -617,7 +752,7 @@
- <a href="/docs/avatica.html" class="next">Next</a>
+ <a href="/docs/stream.html" class="next">Next</a>
</div>
</div>
@@ -646,85 +781,70 @@
-
+
-
+
-
+
-
+
- <li class=""><a href="/docs/index.html">Background</a></li>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-
+
-
+
-
+
-
+
-
+
- <li class=""><a href="/docs/tutorial.html">Tutorial</a></li>
+ <li class=""><a href="/docs/index.html">Background</a></li>
@@ -739,160 +859,102 @@
-
-
-
- <li class=""><a href="/docs/algebra.html">Algebra</a></li>
-
-
-</ul>
-
-
- <h4>Advanced</h4>
-
-<ul>
-
-
-
-
-
-
-
-
- <li class="current"><a href="/docs/adapter.html">Adapters</a></li>
-
-
-
-
-
-
-
-
-
-
-
-
+
- <li class=""><a href="/docs/avatica.html">Avatica</a></li>
-
-
-
-
-
-
-
-
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- <li class=""><a href="/docs/stream.html">Streaming</a></li>
-
-
-
-
-
-
-
-
-
-
-
-
+
-
+
-
+
-
+
- <li class=""><a href="/docs/lattice.html">Lattices</a></li>
-
-
-</ul>
-
- <h4>Reference</h4>
+ <li class=""><a href="/docs/tutorial.html">Tutorial</a></li>
+
-<ul>
@@ -905,39 +967,465 @@
+
+
+
+
+
+
+
+
+
+ <li class=""><a href="/docs/algebra.html">Algebra</a></li>
+
+
+
+</ul>
+
+
+ <h4>Advanced</h4>
+
+
+<ul>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="current"><a href="/docs/adapter.html">Adapters</a></li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class=""><a href="/docs/stream.html">Streaming</a></li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class=""><a href="/docs/lattice.html">Lattices</a></li>
+
+
+
+</ul>
+
+
+ <h4>Avatica</h4>
+
+
+<ul>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class=""><a href="/docs/avatica_overview.html">Overview</a></li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class=""><a href="/docs/avatica_roadmap.html">Roadmap</a></li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class=""><a href="/docs/avatica_json_reference.html">JSON Reference</a></li>
+
+
+
+</ul>
+
+
+ <h4>Reference</h4>
+
+
+<ul>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
<li class=""><a href="/docs/reference.html">SQL language</a></li>
@@ -953,36 +1441,81 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
<li class=""><a href="/docs/model.html">JSON models</a></li>
@@ -998,27 +1531,63 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
<li class=""><a href="/docs/howto.html">HOWTO</a></li>
@@ -1042,21 +1611,51 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
<li class=""><a href="/docs/downloads.html">Downloads</a></li>
@@ -1072,24 +1671,57 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
<li class=""><a href="/docs/history.html">History</a></li>
@@ -1105,18 +1737,45 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
<li class=""><a href="/docs/contributing.html">Contributing</a></li>
@@ -1132,12 +1791,21 @@
+
+
+
+
+
+
+
+
+
<li class=""><a href="/docs/api.html">API</a></li>
Modified: incubator/calcite/site/docs/algebra.html
URL: http://svn.apache.org/viewvc/incubator/calcite/site/docs/algebra.html?rev=1706118&r1=1706117&r2=1706118&view=diff
==============================================================================
--- incubator/calcite/site/docs/algebra.html (original)
+++ incubator/calcite/site/docs/algebra.html Wed Sep 30 18:33:53 2015
@@ -118,6 +118,10 @@
+
+
+
+
@@ -150,6 +154,10 @@
+
+
+
+
@@ -182,6 +190,10 @@
+
+
+
+
</optgroup>
@@ -221,6 +233,89 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ </optgroup>
+
+ <optgroup label="Avatica">
+
+
@@ -253,6 +348,10 @@
+
+
+
+
@@ -285,6 +384,10 @@
+
+
+
+
@@ -317,6 +420,10 @@
+
+
+
+
</optgroup>
@@ -356,6 +463,10 @@
+
+
+
+
@@ -388,6 +499,10 @@
+
+
+
+
@@ -420,6 +535,10 @@
+
+
+
+
</optgroup>
@@ -459,6 +578,10 @@
+
+
+
+
@@ -491,6 +614,10 @@
+
+
+
+
@@ -523,6 +650,10 @@
+
+
+
+
@@ -555,6 +686,10 @@
+
+
+
+
</optgroup>
@@ -805,8 +940,16 @@ return the <code>RelBuilder</code>.</p>
<td style="text-align: left">Creates a <a href="/apidocs/org/apache/calcite/rel/core/Filter.html">Filter</a> over the AND of the given predicates.</td>
</tr>
<tr>
- <td style="text-align: left"><code>project(expr...)</code><br /><code>project(exprList)</code></td>
- <td style="text-align: left">Creates a <a href="/apidocs/org/apache/calcite/rel/core/Project.html">Project</a>. To override the default name, wrap expressions using <code>alias</code>.</td>
+ <td style="text-align: left"><code>project(expr...)</code><br /><code>project(exprList [, fieldNames])</code></td>
+ <td style="text-align: left">Creates a <a href="/apidocs/org/apache/calcite/rel/core/Project.html">Project</a>. To override the default name, wrap expressions using <code>alias</code>, or specify the <code>fieldNames</code> argument.</td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code>permute(mapping)</code></td>
+ <td style="text-align: left">Creates a <a href="/apidocs/org/apache/calcite/rel/core/Project.html">Project</a> that permutes the fields using <code>mapping</code>.</td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code>convert(rowType [, rename])</code></td>
+ <td style="text-align: left">Creates a <a href="/apidocs/org/apache/calcite/rel/core/Project.html">Project</a> that converts the fields to the given types, optionally also renaming them.</td>
</tr>
<tr>
<td style="text-align: left"><code>aggregate(groupKey, aggCall...)</code><br /><code>aggregate(groupKey, aggCallList)</code></td>
@@ -829,16 +972,20 @@ return the <code>RelBuilder</code>.</p>
<td style="text-align: left">Creates a <a href="/apidocs/org/apache/calcite/rel/core/Sort.html">Sort</a> that does not sort, only applies with offset and limit.</td>
</tr>
<tr>
- <td style="text-align: left"><code>join(joinType, expr)</code><br /><code>join(joinType, fieldName...)</code></td>
- <td style="text-align: left">Creates a <a href="/apidocs/org/apache/calcite/rel/core/Join.html">Join</a> of the two most recent relational expressions.<br /><br />The first form joins on an boolean expression.<br /><br />The second form joins on named fields; each side must have a field of each name.</td>
+ <td style="text-align: left"><code>join(joinType, expr...)</code><br /><code>join(joinType, exprList)</code><br /><code>join(joinType, fieldName...)</code></td>
+ <td style="text-align: left">Creates a <a href="/apidocs/org/apache/calcite/rel/core/Join.html">Join</a> of the two most recent relational expressions.<br /><br />The first form joins on a boolean expression (multiple conditions are combined using AND).<br /><br />The last form joins on named fields; each side must have a field of each name.</td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code>semiJoin(expr)</code></td>
+ <td style="text-align: left">Creates a <a href="/apidocs/org/apache/calcite/rel/core/SemiJoin.html">SemiJoin</a> of the two most recent relational expressions.</td>
</tr>
<tr>
- <td style="text-align: left"><code>union(all)</code></td>
- <td style="text-align: left">Creates a <a href="/apidocs/org/apache/calcite/rel/core/Union.html">Union</a> of the two most recent relational expressions.</td>
+ <td style="text-align: left"><code>union(all [, n])</code></td>
+ <td style="text-align: left">Creates a <a href="/apidocs/org/apache/calcite/rel/core/Union.html">Union</a> of the <code>n</code> (default two) most recent relational expressions.</td>
</tr>
<tr>
- <td style="text-align: left"><code>intersect(all)</code></td>
- <td style="text-align: left">Creates an <a href="/apidocs/org/apache/calcite/rel/core/Intersect.html">Intersect</a> of the two most recent relational expressions.</td>
+ <td style="text-align: left"><code>intersect(all [, n])</code></td>
+ <td style="text-align: left">Creates an <a href="/apidocs/org/apache/calcite/rel/core/Intersect.html">Intersect</a> of the <code>n</code> (default two) most recent relational expressions.</td>
</tr>
<tr>
<td style="text-align: left"><code>minus(all)</code></td>
@@ -869,6 +1016,12 @@ return the <code>RelBuilder</code>.</p>
<li><code>alias</code> String</li>
</ul>
+<p>The builder methods perform various optimizations, including:
+* <code>project</code> returns its input if asked to project all columns in order
+* <code>filter</code> flattens the condition (so an <code>AND</code> and <code>OR</code> may have more than 2 children),
+ simplifies (converting say <code>x = 1 AND TRUE</code> to <code>x = 1</code>)
+* If you apply <code>sort</code> then <code>limit</code>, the effect is as if you had called <code>sortLimit</code></p>
+
<h3 id="stack-methods">Stack methods</h3>
<table>
@@ -888,6 +1041,10 @@ return the <code>RelBuilder</code>.</p>
<td style="text-align: left">Pushes a relational expression onto the stack. Relational methods such as <code>scan</code>, above, call this method, but user code generally does not</td>
</tr>
<tr>
+ <td style="text-align: left"><code>pushAll(collection)</code></td>
+ <td style="text-align: left">Pushes a collection of relational expressions onto the stack</td>
+ </tr>
+ <tr>
<td style="text-align: left"><code>peek()</code></td>
<td style="text-align: left">Returns the relational expression most recently put onto the stack, but does not remove it</td>
</tr>
@@ -932,6 +1089,18 @@ added to the stack.</p>
<td style="text-align: left">Reference, by ordinal, to a field of the (<code>inputCount</code> - <code>inputOrdinal</code>)th relational expression</td>
</tr>
<tr>
+ <td style="text-align: left"><code>fields(fieldOrdinalList)</code></td>
+ <td style="text-align: left">List of expressions referencing input fields by ordinal</td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code>fields(mapping)</code></td>
+ <td style="text-align: left">List of expressions referencing input fields by a given mapping</td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code>fields(collation)</code></td>
+ <td style="text-align: left">List of expressions, <code>exprList</code>, such that <code>sort(exprList)</code> would replicate collation</td>
+ </tr>
+ <tr>
<td style="text-align: left"><code>call(op, expr...)</code><br /><code>call(op, exprList)</code></td>
<td style="text-align: left">Call to a function or operator</td>
</tr>
@@ -999,6 +1168,14 @@ added to the stack.</p>
<td style="text-align: left"><code>groupKey(fieldName...)</code><br /><code>groupKey(fieldOrdinal...)</code><br /><code>groupKey(expr...)</code><br /><code>groupKey(exprList)</code></td>
<td style="text-align: left">Creates a group key of the given expressions</td>
</tr>
+ <tr>
+ <td style="text-align: left"><code>groupKey(exprList, exprListList)</code></td>
+ <td style="text-align: left">Creates a group key of the given expressions with grouping sets</td>
+ </tr>
+ <tr>
+ <td style="text-align: left"><code>groupKey(bitSet, bitSets)</code></td>
+ <td style="text-align: left">Creates a group key of the given input columns with grouping sets</td>
+ </tr>
</tbody>
</table>
@@ -1016,8 +1193,8 @@ added to the stack.</p>
</thead>
<tbody>
<tr>
- <td style="text-align: left"><code>aggregateCall(op, distinct, alias, expr...)</code><br /><code>aggregateCall(op, distinct, alias, exprList)</code></td>
- <td style="text-align: left">Creates a call to a given aggregate function</td>
+ <td style="text-align: left"><code>aggregateCall(op, distinct, filter, alias, expr...)</code><br /><code>aggregateCall(op, distinct, filter, alias, exprList)</code></td>
+ <td style="text-align: left">Creates a call to a given aggregate function, with an optional filter expression</td>
</tr>
<tr>
<td style="text-align: left"><code>count(distinct, alias, expr...)</code></td>
@@ -1097,30 +1274,69 @@ added to the stack.</p>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
<li class=""><a href="/docs/index.html">Background</a></li>
@@ -1136,45 +1352,99 @@ added to the stack.</p>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
<li class=""><a href="/docs/tutorial.html">Tutorial</a></li>
@@ -1190,9 +1460,15 @@ added to the stack.</p>
+
+
+
+
+
+
<li class="current"><a href="/docs/algebra.html">Algebra</a></li>
@@ -1216,6 +1492,9 @@ added to the stack.</p>
+
+
+
<li class=""><a href="/docs/adapter.html">Adapters</a></li>
@@ -1231,16 +1510,94 @@ added to the stack.</p>
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- <li class=""><a href="/docs/avatica.html">Avatica</a></li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class=""><a href="/docs/stream.html">Streaming</a></li>
@@ -1255,43 +1612,126 @@ added to the stack.</p>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class=""><a href="/docs/lattice.html">Lattices</a></li>
+
+
+
+</ul>
+
+
+ <h4>Avatica</h4>
+
+
+<ul>
+
+
+
+
+
+
+
+
+
- <li class=""><a href="/docs/stream.html">Streaming</a></li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class=""><a href="/docs/avatica_overview.html">Overview</a></li>
@@ -1306,34 +1746,76 @@ added to the stack.</p>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class=""><a href="/docs/avatica_roadmap.html">Roadmap</a></li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- <li class=""><a href="/docs/lattice.html">Lattices</a></li>
+
+
+
+ <li class=""><a href="/docs/avatica_json_reference.html">JSON Reference</a></li>
@@ -1356,39 +1838,87 @@ added to the stack.</p>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
<li class=""><a href="/docs/reference.html">SQL language</a></li>
@@ -1404,36 +1934,81 @@ added to the stack.</p>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
<li class=""><a href="/docs/model.html">JSON models</a></li>
@@ -1449,27 +2024,63 @@ added to the stack.</p>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
<li class=""><a href="/docs/howto.html">HOWTO</a></li>
@@ -1493,21 +2104,51 @@ added to the stack.</p>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
<li class=""><a href="/docs/downloads.html">Downloads</a></li>
@@ -1523,24 +2164,57 @@ added to the stack.</p>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
<li class=""><a href="/docs/history.html">History</a></li>
@@ -1556,18 +2230,45 @@ added to the stack.</p>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
<li class=""><a href="/docs/contributing.html">Contributing</a></li>
@@ -1583,12 +2284,21 @@ added to the stack.</p>
+
+
+
+
+
+
+
+
+
<li class=""><a href="/docs/api.html">API</a></li>
Added: incubator/calcite/site/docs/avatica_json_reference.html
URL: http://svn.apache.org/viewvc/incubator/calcite/site/docs/avatica_json_reference.html?rev=1706118&view=auto
==============================================================================
--- incubator/calcite/site/docs/avatica_json_reference.html (added)
+++ incubator/calcite/site/docs/avatica_json_reference.html Wed Sep 30 18:33:53 2015
@@ -0,0 +1,2453 @@
+<!DOCTYPE HTML>
+<html lang="en-US">
+<head>
+ <meta charset="UTF-8">
+ <title>Avatica JSON Reference</title>
+ <meta name="viewport" content="width=device-width,initial-scale=1">
+ <meta name="generator" content="Jekyll v2.4.0">
+ <link rel="stylesheet" href="//fonts.googleapis.com/css?family=Lato:300,300italic,400,400italic,700,700italic,900">
+ <link rel="stylesheet" href="/css/screen.css">
+ <link rel="icon" type="image/x-icon" href="/favicon.ico">
+ <!--[if lt IE 9]>
+ <script src="/js/html5shiv.min.js"></script>
+ <script src="/js/respond.min.js"></script>
+ <![endif]-->
+</head>
+
+
+<body class="wrap">
+ <header role="banner">
+ <nav class="mobile-nav show-on-mobiles">
+ <ul>
+ <li class="">
+ <a href="/">Home</a>
+ </li>
+ <li class="current">
+ <a href="/docs/">Documentation</a>
+ </li>
+ <li class="">
+ <a href="/talks/">Talks</a>
+ </li>
+ <li class="">
+ <a href="/news/">News</a>
+ </li>
+ <li class="">
+ <a href="/help/">Help</a>
+ </li>
+ <li class="">
+ <a href="/develop/">Develop</a>
+ </li>
+</ul>
+
+ </nav>
+ <div class="grid">
+ <div class="unit one-third center-on-mobiles">
+ <h1>
+ <a href="/">
+ <span class="sr-only">Apache Calcite</span>
+ <img src="/img/logo.png" width="226" height="140" alt="Calcite Logo">
+ </a>
+ </h1>
+ </div>
+ <nav class="main-nav unit two-thirds hide-on-mobiles">
+ <ul>
+ <li class="">
+ <a href="/">Home</a>
+ </li>
+ <li class="current">
+ <a href="/docs/">Documentation</a>
+ </li>
+ <li class="">
+ <a href="/talks/">Talks</a>
+ </li>
+ <li class="">
+ <a href="/news/">News</a>
+ </li>
+ <li class="">
+ <a href="/help/">Help</a>
+ </li>
+ <li class="">
+ <a href="/develop/">Develop</a>
+ </li>
+</ul>
+
+ </nav>
+ </div>
+</header>
+
+
+ <section class="docs">
+ <div class="grid">
+
+ <div class="docs-nav-mobile unit whole show-on-mobiles">
+ <select onchange="if (this.value) window.location.href=this.value">
+ <option value="">Navigate the docsâ¦</option>
+
+ <optgroup label="Overview">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ </optgroup>
+
+ <optgroup label="Advanced">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ </optgroup>
+
+ <optgroup label="Avatica">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ </optgroup>
+
+ <optgroup label="Reference">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ </optgroup>
+
+ <optgroup label="Meta">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ </optgroup>
+
+ </select>
+</div>
+
+
+ <div class="unit four-fifths">
+ <article>
+ <h1>Avatica JSON Reference</h1>
+ <!--
+
+-->
+
+<p>As Avatica uses JSON to serialize messages sent over an HTTP transport,
+the RPC layer is agnostic of the language used by a client. While the Avatica
+server is written in Java, this enables clients to interact with the server
+using any language instead of being limited to Java.</p>
+
+<p>A specification of the JSON request and response objects are documented
+below. Programmatic bindings for these JSON objects are only available
+in Java, so non-Java clients presently must re-implement language
+specific objects on their own. Efforts to use <a href="https://developers.google.com/protocol-buffers/">Protocol Buffers</a>
+instead are underway that will provide native objects in many languages.</p>
+
+<h2 id="index">Index</h2>
+
+<h3 id="requests">Requests</h3>
+<ul>
+ <li><a href="#catalogsrequest">CatalogsRequest</a></li><li><a href="#closeconnectionrequest">CloseConnectionRequest</a></li><li><a href="#closestatementrequest">CloseStatementRequest</a></li><li><a href="#columnsrequest">ColumnsRequest</a></li><li><a href="#connectionsyncrequest">ConnectionSyncRequest</a></li><li><a href="#createstatementrequest">CreateStatementRequest</a></li><li><a href="#databasepropertyrequest">DatabasePropertyRequest</a></li><li><a href="#fetchrequest">FetchRequest</a></li><li><a href="#prepareandexecuterequest">PrepareAndExecuteRequest</a></li><li><a href="#preparerequest">PrepareRequest</a></li><li><a href="#schemasrequest">SchemasRequest</a></li><li><a href="#tabletypesrequest">TableTypesRequest</a></li><li><a href="#tablesrequest">TablesRequest</a></li><li><a href="#typeinforequest">TypeInfoRequest</a></li>
+</ul>
+
+<h3 id="responses">Responses</h3>
+<ul>
+ <li><a href="#resultsetresponse">ResultSetResponse</a></li><li><a href="#executeresponse">ExecuteResponse</a></li><li><a href="#prepareresponse">PrepareResponse</a></li><li><a href="#fetchresponse">FetchResponse</a></li><li><a href="#createstatementresponse">CreateStatementResponse</a></li><li><a href="#closestatementresponse">CloseStatementResponse</a></li><li><a href="#closeconnectionresponse">CloseConnectionResponse</a></li><li><a href="#connectionsyncresponse">ConnectionSyncResponse</a></li><li><a href="#databasepropertyresponse">DatabasePropertyResponse</a></li>
+</ul>
+
+<h3 id="miscellaneous">Miscellaneous</h3>
+<ul>
+ <li><a href="#connectionproperties">ConnectionProperties</a></li><li><a href="#typedvalue">TypedValue</a></li><li><a href="#signature">Signature</a></li><li><a href="#frame">Frame</a></li><li><a href="#statementhandle">StatementHandle</a></li><li><a href="#databaseproperty">DatabaseProperty</a></li><li><a href="#columnmetadata">ColumnMetaData</a></li><li><a href="#avaticaparameter">AvaticaParameter</a></li><li><a href="#avaticatype">AvaticaType</a></li><li><a href="#rep">Rep</a></li><li><a href="#cursorfactory">CursorFactory</a></li><li><a href="#style">Style</a></li>
+</ul>
+
+<h2 id="requests-1">Requests</h2>
+
+<p>The collection of all JSON objects accepted as requests to Avatica. All Requests include a <code>request</code> attribute
+which uniquely identifies the concrete Request from all other Requests.</p>
+
+<h3 id="catalogsrequest">CatalogsRequest</h3>
+
+<div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
+ <span class="nt">"request"</span><span class="p">:</span> <span class="s2">"getCatalogs"</span><span class="p">,</span>
+<span class="p">}</span></code></pre></div>
+
+<p>There are no extra attributes on this Request.</p>
+
+<h3 id="closeconnectionrequest">CloseConnectionRequest</h3>
+
+<div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
+ <span class="nt">"request"</span><span class="p">:</span> <span class="s2">"closeConnection"</span><span class="p">,</span>
+ <span class="nt">"connectionId"</span><span class="p">:</span> <span class="s2">"000000-0000-0000-00000000"</span>
+<span class="p">}</span></code></pre></div>
+
+<p><code>connectionId</code> (required string) The identifier of the connection to close.</p>
+
+<h3 id="closestatementrequest">CloseStatementRequest</h3>
+
+<div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
+ <span class="nt">"request"</span><span class="p">:</span> <span class="s2">"closeStatement"</span><span class="p">,</span>
+ <span class="nt">"connectionId"</span><span class="p">:</span> <span class="s2">"000000-0000-0000-00000000"</span><span class="p">,</span>
+ <span class="nt">"statementId"</span><span class="p">:</span> <span class="mi">12345</span>
+<span class="p">}</span></code></pre></div>
+
+<p><code>connectionId</code> (required string) The identifier of the connection to which the statement belongs.</p>
+
+<p><code>statementId</code> (required integer) The identifier of the statement to close.</p>
+
+<h3 id="columnsrequest">ColumnsRequest</h3>
+
+<div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
+ <span class="nt">"request"</span><span class="p">:</span> <span class="s2">"getColumns"</span><span class="p">,</span>
+ <span class="nt">"catalog"</span><span class="p">:</span> <span class="s2">"catalog"</span><span class="p">,</span>
+ <span class="nt">"schemaPattern"</span><span class="p">:</span> <span class="s2">"schema_pattern.*"</span><span class="p">,</span>
+ <span class="nt">"tableNamePattern"</span><span class="p">:</span> <span class="s2">"table_pattern.*"</span><span class="p">,</span>
+ <span class="nt">"columnNamePattern"</span><span class="p">:</span> <span class="s2">"column_pattern.*"</span>
+<span class="p">}</span></code></pre></div>
+
+<p><code>catalog</code> (optional string) The name of a catalog to limit returned columns.</p>
+
+<p><code>schemaPattern</code> (optional string) A Java Pattern against schemas to limit returned columns.</p>
+
+<p><code>tableNamePattern</code> (optional string) A Java Pattern against table names to limit returned columns.</p>
+
+<p><code>columnNamePattern</code> (optional string) A Java Pattern against column names to limit returned columns.</p>
+
+<h3 id="connectionsyncrequest">ConnectionSyncRequest</h3>
+
+<div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
+ <span class="nt">"request"</span><span class="p">:</span> <span class="s2">"connectionSync"</span><span class="p">,</span>
+ <span class="nt">"connectionId"</span><span class="p">:</span> <span class="s2">"000000-0000-0000-00000000"</span><span class="p">,</span>
+ <span class="nt">"connProps"</span><span class="p">:</span> <span class="err">ConnectionProperties</span>
+<span class="p">}</span></code></pre></div>
+
+<p><code>connectionId</code> (required string) The identifier of the connection to synchronize.</p>
+
+<p><code>connProps</code> (optional nested object) A <a href="#connectionproperties">ConnectionProperties</a> object to synchronize between the client and server.</p>
+
+<h3 id="createstatementrequest">CreateStatementRequest</h3>
+
+<div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
+ <span class="nt">"request"</span><span class="p">:</span> <span class="s2">"createStatement"</span><span class="p">,</span>
+ <span class="nt">"connectionId"</span><span class="p">:</span> <span class="s2">"000000-0000-0000-00000000"</span>
+<span class="p">}</span></code></pre></div>
+
+<p><code>connectionId</code> (required string) The identifier of the connection to use in creating a statement.</p>
+
+<h3 id="databasepropertyrequest">DatabasePropertyRequest</h3>
+
+<div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
+ <span class="nt">"request"</span><span class="p">:</span> <span class="s2">"databaseProperties"</span><span class="p">,</span>
+<span class="p">}</span></code></pre></div>
+
+<p>There are no extra attributes on this Request.</p>
+
+<h3 id="fetchrequest">FetchRequest</h3>
+
+<div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
+ <span class="nt">"request"</span><span class="p">:</span> <span class="s2">"fetch"</span><span class="p">,</span>
+ <span class="nt">"connectionId"</span><span class="p">:</span> <span class="s2">"000000-0000-0000-00000000"</span><span class="p">,</span>
+ <span class="nt">"statementId"</span><span class="p">:</span> <span class="mi">12345</span><span class="p">,</span>
+ <span class="nt">"offset"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="nt">"fetchMaxRowCount"</span><span class="p">:</span> <span class="mi">100</span><span class="p">,</span>
+ <span class="nt">"parameterValues"</span><span class="p">:</span> <span class="p">[</span><span class="err">TypedValue</span><span class="p">,</span> <span class="err">TypedValue</span><span class="p">,</span> <span class="err">...</span><span class="p">]</span>
+<span class="p">}</span></code></pre></div>
+
+<p><code>connectionId</code> (required string) The identifier of the connection to use.</p>
+
+<p><code>statementId</code> (required integer) The identifier of the statement created using the above connection.</p>
+
+<p><code>offset</code> (required integer) The positional offset into a result set to fetch.</p>
+
+<p><code>fetchMatchRowCount</code> (required integer) The maximum number of rows to return in the response to this request.</p>
+
+<p><code>parameterValues</code> (optional array of nested objects) The types of the object to set on the prepared statement in use.</p>
+
+<h3 id="prepareandexecuterequest">PrepareAndExecuteRequest</h3>
+
+<div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
+ <span class="nt">"request"</span><span class="p">:</span> <span class="s2">"prepareAndExecute"</span><span class="p">,</span>
+ <span class="nt">"connectionId"</span><span class="p">:</span> <span class="s2">"000000-0000-0000-00000000"</span><span class="p">,</span>
+ <span class="nt">"statementId"</span><span class="p">:</span> <span class="mi">12345</span><span class="p">,</span>
+ <span class="nt">"sql"</span><span class="p">:</span> <span class="s2">"SELECT * FROM table"</span><span class="p">,</span>
+ <span class="nt">"maxRowCount"</span><span class="p">:</span> <span class="mi">100</span><span class="p">,</span>
+<span class="p">}</span></code></pre></div>
+
+<p><code>connectionId</code> (required string) The identifier for the connection to use.</p>
+
+<p><code>statementId</code> (required integer) The identifier for the statement created by the above connection to use.</p>
+
+<p><code>sql</code> (required string) A SQL statement</p>
+
+<p><code>maxRowCount</code> (required long) The maximum number of rows returned in the response.</p>
+
+<h3 id="preparerequest">PrepareRequest</h3>
+
+<div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
+ <span class="nt">"request"</span><span class="p">:</span> <span class="s2">"prepare"</span><span class="p">,</span>
+ <span class="nt">"connectionId"</span><span class="p">:</span> <span class="s2">"000000-0000-0000-00000000"</span><span class="p">,</span>
+ <span class="nt">"sql"</span><span class="p">:</span> <span class="s2">"SELECT * FROM table"</span><span class="p">,</span>
+ <span class="nt">"maxRowCount"</span><span class="p">:</span> <span class="mi">100</span><span class="p">,</span>
+<span class="p">}</span></code></pre></div>
+
+<p><code>connectionId</code> (required string) The identifier for the connection to use.</p>
+
+<p><code>sql</code> (required string) A SQL statement</p>
+
+<p><code>maxRowCount</code> (required long) The maximum number of rows returned in the response.</p>
+
+<h3 id="schemasrequest">SchemasRequest</h3>
+
+<div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
+ <span class="nt">"request"</span><span class="p">:</span> <span class="s2">"getSchemas"</span><span class="p">,</span>
+ <span class="nt">"catalog"</span><span class="p">:</span> <span class="s2">"name"</span><span class="p">,</span>
+ <span class="nt">"schemaPattern"</span><span class="p">:</span> <span class="s2">"pattern.*"</span>
+<span class="p">}</span></code></pre></div>
+
+<p><code>catalog</code> (required string) The name of the catalog to fetch the schema from.</p>
+
+<p><code>schemaPattern</code> (required string) A Java pattern of schemas to fetch.</p>
+
+<h3 id="tabletypesrequest">TableTypesRequest</h3>
+
+<div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
+ <span class="nt">"request"</span><span class="p">:</span> <span class="s2">"getTableTypes"</span><span class="p">,</span>
+<span class="p">}</span></code></pre></div>
+
+<p>There are no extra attributes on this Request.</p>
+
+<h3 id="tablesrequest">TablesRequest</h3>
+
+<div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
+ <span class="nt">"request"</span><span class="p">:</span> <span class="s2">"getTables"</span><span class="p">,</span>
+ <span class="nt">"catalog"</span><span class="p">:</span> <span class="s2">"catalog_name"</span><span class="p">,</span>
+ <span class="nt">"schemaPattern"</span><span class="p">:</span> <span class="s2">"schema_pattern.*"</span><span class="p">,</span>
+ <span class="nt">"tableNamePattern"</span><span class="p">:</span> <span class="s2">"table_name_pattern.*"</span><span class="p">,</span>
+ <span class="nt">"typeList"</span><span class="p">:</span> <span class="p">[</span> <span class="s2">"TABLE"</span><span class="p">,</span> <span class="s2">"VIEW"</span><span class="p">,</span> <span class="err">...</span> <span class="p">]</span>
+<span class="p">}</span></code></pre></div>
+
+<p><code>catalog</code> (optional string) The name of a catalog to restrict fetched tables.</p>
+
+<p><code>schemaPattern</code> (optional string) A Java Pattern representing schemas to include in fetched tables.</p>
+
+<p><code>tableNamePattern</code> (optional string) A Java Pattern representing table names to include in fetched tables.</p>
+
+<p><code>typeList</code> (optional array of string) A list of table types used to restrict fetched tables.</p>
+
+<h3 id="typeinforequest">TypeInfoRequest</h3>
+
+<div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
+ <span class="nt">"request"</span><span class="p">:</span> <span class="s2">"getTypeInfo"</span><span class="p">,</span>
+<span class="p">}</span></code></pre></div>
+
+<p>There are no extra attributes on this Request.</p>
+
+<h2 id="responses-1">Responses</h2>
+
+<p>The collection of all JSON objects returned as responses from Avatica. All Responses include a <code>response</code> attribute
+which uniquely identifies the concrete Response from all other Responses.</p>
+
+<h3 id="resultsetresponse">ResultSetResponse</h3>
+
+<div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
+ <span class="nt">"response"</span><span class="p">:</span> <span class="s2">"resultSet"</span><span class="p">,</span>
+ <span class="nt">"connectionId"</span><span class="p">:</span> <span class="s2">"000000-0000-0000-00000000"</span><span class="p">,</span>
+ <span class="nt">"statementId"</span><span class="p">:</span> <span class="mi">12345</span><span class="p">,</span>
+ <span class="nt">"ownStatement"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
+ <span class="nt">"signature"</span><span class="p">:</span> <span class="err">Signature</span><span class="p">,</span>
+ <span class="nt">"firstFrame"</span><span class="p">:</span> <span class="err">Frame</span><span class="p">,</span>
+ <span class="nt">"updateCount"</span><span class="p">:</span> <span class="mi">10</span>
+<span class="p">}</span></code></pre></div>
+
+<p><code>connectionId</code> The identifier for the connection used to generate this response.</p>
+
+<p><code>statementId</code> The identifier for the statement used to generate this response.</p>
+
+<p><code>ownStatement</code> Whether the result set has its own dedicated statement. If true, the server must automatically close the
+statement when the result set is closed. This is used for JDBC metadata result sets, for instance.</p>
+
+<p><code>signature</code> A non-optional nested object <a href="#signature">Signature</a></p>
+
+<p><code>firstFrame</code> A optional nested object <a href="#frame">Frame</a></p>
+
+<p><code>updateCount</code> A number which is always <code>-1</code> for normal result sets. Any other value denotes a âdummyâ result set
+that only contains this count and no additional data.</p>
+
+<h3 id="executeresponse">ExecuteResponse</h3>
+
+<div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
+ <span class="nt">"response"</span><span class="p">:</span> <span class="s2">"Service$ExecuteResponse"</span><span class="p">,</span>
+ <span class="nt">"resultSets"</span><span class="p">:</span> <span class="p">[</span> <span class="err">ResultSetResponse</span><span class="p">,</span> <span class="err">ResultSetResponse</span><span class="p">,</span> <span class="err">...</span> <span class="p">]</span>
+<span class="p">}</span></code></pre></div>
+
+<p><code>resultSets</code> An array of <a href="#resultsetresponse">ResultSetResponse</a>s.</p>
+
+<h3 id="prepareresponse">PrepareResponse</h3>
+
+<div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
+ <span class="nt">"response"</span><span class="p">:</span> <span class="s2">"prepare"</span><span class="p">,</span>
+ <span class="nt">"statement"</span><span class="p">:</span> <span class="err">StatementHandle</span>
+<span class="p">}</span></code></pre></div>
+
+<p><code>statement</code> A <a href="#statementhandle">StatementHandle</a> object.</p>
+
+<h3 id="fetchresponse">FetchResponse</h3>
+
+<div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
+ <span class="nt">"response"</span><span class="p">:</span> <span class="s2">"fetch"</span><span class="p">,</span>
+ <span class="nt">"frame"</span><span class="p">:</span> <span class="err">Frame</span>
+<span class="p">}</span></code></pre></div>
+
+<p><code>frame</code> A <a href="#frame">Frame</a> containing the results of the fetch.</p>
+
+<h3 id="createstatementresponse">CreateStatementResponse</h3>
+
+<div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
+ <span class="nt">"response"</span><span class="p">:</span> <span class="s2">"createStatement"</span><span class="p">,</span>
+ <span class="nt">"connectionId"</span><span class="p">:</span> <span class="s2">"000000-0000-0000-00000000"</span><span class="p">,</span>
+ <span class="nt">"statementId"</span><span class="p">:</span> <span class="mi">12345</span>
+<span class="p">}</span></code></pre></div>
+
+<p><code>connectionId</code> The identifier for the connection used to create the statement.</p>
+
+<p><code>statementId</code> The identifier for the created statement.</p>
+
+<h3 id="closestatementresponse">CloseStatementResponse</h3>
+
+<div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
+ <span class="nt">"response"</span><span class="p">:</span> <span class="s2">"closeStatement"</span><span class="p">,</span>
+<span class="p">}</span></code></pre></div>
+
+<p>This response has no attributes.</p>
+
+<h3 id="closeconnectionresponse">CloseConnectionResponse</h3>
+
+<div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
+ <span class="nt">"response"</span><span class="p">:</span> <span class="s2">"closeConnection"</span><span class="p">,</span>
+<span class="p">}</span></code></pre></div>
+
+<p>There are no extra attributes on this Response.</p>
+
+<h3 id="connectionsyncresponse">ConnectionSyncResponse</h3>
+
+<div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
+ <span class="nt">"response"</span><span class="p">:</span> <span class="s2">"connectionSync"</span><span class="p">,</span>
+ <span class="nt">"connProps"</span><span class="p">:</span> <span class="err">ConnectionProperties</span>
+<span class="p">}</span></code></pre></div>
+
+<p><code>connProps</code> The <a href="#connectionproperties">ConnectionProperties</a> that were synchronized.</p>
+
+<h3 id="databasepropertyresponse">DatabasePropertyResponse</h3>
+
+<div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
+ <span class="nt">"response"</span><span class="p">:</span> <span class="s2">"databaseProperties"</span><span class="p">,</span>
+ <span class="nt">"map"</span><span class="p">:</span> <span class="p">{</span> <span class="err">DatabaseProperty:</span> <span class="err">Object,</span> <span class="err">DatabaseProperty:</span> <span class="err">Object,</span> <span class="err">...</span> <span class="p">}</span>
+<span class="p">}</span></code></pre></div>
+
+<p><code>map</code> A map of <a href="#databaseproperty">DatabaseProperty</a> to value of that property. The value may be some
+primitive type or an array of primitive types.</p>
+
+<h2 id="miscellaneous-1">Miscellaneous</h2>
+
+<h3 id="connectionproperties">ConnectionProperties</h3>
+
+<div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
+ <span class="nt">"connProps"</span><span class="p">:</span> <span class="s2">"connPropsImpl"</span><span class="p">,</span>
+ <span class="nt">"autoCommit"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
+ <span class="nt">"readOnly"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
+ <span class="nt">"transactionIsolation"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="nt">"catalog"</span><span class="p">:</span> <span class="s2">"catalog"</span><span class="p">,</span>
+ <span class="nt">"schema"</span><span class="p">:</span> <span class="s2">"schema"</span>
+<span class="p">}</span></code></pre></div>
+
+<p><code>autoCommit</code> (optional boolean) A boolean denoting if autoCommit is enabled for transactions.</p>
+
+<p><code>readOnly</code> (optional boolean) A boolean denoting if a JDBC connection is read-only.</p>
+
+<p><code>transactionIsolation</code> (optional integer) An integer which denotes the level of transactions isolation per the JDBC
+specification. This value is analogous to the values define in <code>java.sql.Connection</code>.</p>
+
+<ul>
+ <li>0 = Transactions are not supported</li>
+ <li>1 = Dirty reads, non-repeatable reads and phantom reads may occur.</li>
+ <li>2 = Dirty reads are prevented, but non-repeatable reads and phantom reads may occur.</li>
+ <li>4 = Dirty reads and non-repeatable reads are prevented, but phantom reads may occur.</li>
+ <li>8 = Dirty reads, non-repeatable reads, and phantom reads are all prevented.</li>
+</ul>
+
+<h3 id="typedvalue">TypedValue</h3>
+
+<div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
+ <span class="nt">"type"</span><span class="p">:</span> <span class="s2">"type_name"</span><span class="p">,</span>
+ <span class="nt">"value"</span><span class="p">:</span> <span class="err">object</span>
+<span class="p">}</span></code></pre></div>
+
+<p><code>type</code> A name referring to the type of the object stored in <code>value</code>.</p>
+
+<p><code>value</code> A JSON representation of a JDBC type.</p>
+
+<h3 id="signature">Signature</h3>
+
+<div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
+ <span class="nt">"columns"</span><span class="p">:</span> <span class="p">[</span> <span class="err">ColumnMetaData</span><span class="p">,</span> <span class="err">ColumnMetaData</span><span class="p">,</span> <span class="err">...</span> <span class="p">],</span>
+ <span class="nt">"sql"</span><span class="p">:</span> <span class="s2">"SELECT * FROM table"</span><span class="p">,</span>
+ <span class="nt">"parameters"</span><span class="p">:</span> <span class="p">[</span> <span class="err">AvaticaParameter</span><span class="p">,</span> <span class="err">AvaticaParameter</span><span class="p">,</span> <span class="err">...</span> <span class="p">],</span>
+ <span class="nt">"cursorFactory"</span><span class="p">:</span> <span class="err">CursorFactory</span>
+<span class="p">}</span></code></pre></div>
+
+<p><code>columns</code> An array of <a href="#columnmetadata">ColumnMetaData</a> objects denoting the schema of the result set.</p>
+
+<p><code>sql</code> The SQL executed.</p>
+
+<p><code>parameters</code> An array of <a href="#avaticaparameter">AvaticaParameter</a> objects denoting type-specific details.</p>
+
+<p><code>cursorFactory</code> An <a href="#cursorfactory">CursorFactory</a> object representing the Java representation of the frame.</p>
+
+<h3 id="frame">Frame</h3>
+
+<div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
+ <span class="nt">"offset"</span><span class="p">:</span> <span class="mi">100</span><span class="p">,</span>
+ <span class="nt">"done"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
+ <span class="nt">"rows"</span><span class="p">:</span> <span class="p">[</span> <span class="p">[</span> <span class="err">val</span><span class="mi">1</span><span class="p">,</span> <span class="err">val</span><span class="mi">2</span><span class="p">,</span> <span class="err">...</span> <span class="p">],</span> <span class="err">...</span> <span class="p">]</span>
+<span class="p">}</span></code></pre></div>
+
+<p><code>offset</code> The starting position of these <code>rows</code> in the encompassing result set.</p>
+
+<p><code>done</code> A boolean denoting whether more results exist for this result set.</p>
+
+<p><code>rows</code> An array of arrays corresponding to the rows and columns for the result set.</p>
+
+<h3 id="statementhandle">StatementHandle</h3>
+
+<div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
+ <span class="nt">"connectionId"</span><span class="p">:</span> <span class="s2">"000000-0000-0000-00000000"</span><span class="p">,</span>
+ <span class="nt">"id"</span><span class="p">:</span> <span class="mi">12345</span><span class="p">,</span>
+ <span class="nt">"signature"</span><span class="p">:</span> <span class="err">Signature</span>
+<span class="p">}</span></code></pre></div>
+
+<p><code>connectionId</code> The identifier of the connection to which this statement belongs.</p>
+
+<p><code>id</code> The identifier of the statement.</p>
+
+<p><code>signature</code> A <a href="#signature">Signature</a> object for the statement.</p>
+
+<h3 id="databaseproperty">DatabaseProperty</h3>
+
+<p>One of:</p>
+
+<ul>
+ <li>âGET_STRING_FUNCTIONSâ</li>
+ <li>âGET_NUMERIC_FUNCTIONSâ</li>
+ <li>âGET_SYSTEM_FUNCTIONSâ</li>
+ <li>âGET_TIME_DATE_FUNCTIONSâ</li>
+ <li>âGET_S_Q_L_KEYWORDSâ</li>
+ <li>âGET_DEFAULT_TRANSACTION_ISOLATIONâ</li>
+</ul>
+
+<h3 id="columnmetadata">ColumnMetaData</h3>
+
+<div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
+ <span class="nt">"ordinal"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="nt">"autoIncrement"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
+ <span class="nt">"caseSensitive"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
+ <span class="nt">"searchable"</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
+ <span class="nt">"currency"</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
+ <span class="nt">"nullable"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="nt">"signed"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
+ <span class="nt">"displaySize"</span><span class="p">:</span> <span class="mi">20</span><span class="p">,</span>
+ <span class="nt">"label"</span><span class="p">:</span> <span class="s2">"Description"</span><span class="p">,</span>
+ <span class="nt">"columnName"</span><span class="p">:</span> <span class="s2">"col1"</span><span class="p">,</span>
+ <span class="nt">"schemaName"</span><span class="p">:</span> <span class="s2">"schema"</span><span class="p">,</span>
+ <span class="nt">"precision"</span><span class="p">:</span> <span class="mi">10</span><span class="p">,</span>
+ <span class="nt">"scale"</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span>
+ <span class="nt">"tableName"</span><span class="p">:</span> <span class="s2">"table"</span><span class="p">,</span>
+ <span class="nt">"catalogName"</span><span class="p">:</span> <span class="s2">"catalog"</span><span class="p">,</span>
+ <span class="nt">"type"</span><span class="p">:</span> <span class="err">AvaticaType</span><span class="p">,</span>
+ <span class="nt">"readOnly"</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
+ <span class="nt">"writable"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
+ <span class="nt">"definitelyWritable"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
+ <span class="nt">"columnClassName"</span><span class="p">:</span> <span class="s2">"java.lang.String"</span>
+<span class="p">}</span></code></pre></div>
+
+<p><code>ordinal</code> A positional offset number.</p>
+
+<p><code>autoIncrement</code> A boolean denoting whether the column is automatically incremented.</p>
+
+<p><code>caseSensitive</code> A boolean denoting whether the column is case sensitive.</p>
+
+<p><code>searchable</code> A boolean denoting whether this column supports all WHERE search clauses.</p>
+
+<p><code>currency</code> A boolean denoting whether this column represents currency.</p>
+
+<p><code>nullable</code> A number denoting whether this column supports null values.</p>
+
+<ul>
+ <li>0 = No null values are allowed</li>
+ <li>1 = Null values are allowed</li>
+ <li>2 = It is unknown if null values are allowed</li>
+</ul>
+
+<p><code>signed</code> A boolean denoting whether the column is a signed numeric.</p>
+
+<p><code>displaySize</code> The character width of the column.</p>
+
+<p><code>label</code> A description for this column.</p>
+
+<p><code>columnName</code> The name of the column.</p>
+
+<p><code>schemaName</code> The schema to which this column belongs.</p>
+
+<p><code>precision</code> The maximum numeric precision supported by this column.</p>
+
+<p><code>scale</code> The maximum numeric scale supported by this column.</p>
+
+<p><code>tableName</code> The name of the table to which this column belongs.</p>
+
+<p><code>catalogName</code> The name of the catalog to which this column belongs.</p>
+
+<p><code>type</code> A nested <a href="#avaticatype">AvaticaType</a> representing the type of the column.</p>
+
+<p><code>readOnly</code> A boolean denoting whether the column is read-only.</p>
+
+<p><code>writable</code> A boolean denoting whether the column is possible to be updated.</p>
+
+<p><code>definitelyWritable</code> A boolean denoting whether the column definitely can be updated.</p>
+
+<p><code>columnClassName</code> The name of the Java class backing the columnâs type.</p>
+
+<h3 id="avaticaparameter">AvaticaParameter</h3>
+
+<div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
+ <span class="nt">"signed"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
+ <span class="nt">"precision"</span><span class="p">:</span> <span class="mi">10</span><span class="p">,</span>
+ <span class="nt">"scale"</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span>
+ <span class="nt">"parameterType"</span><span class="p">:</span> <span class="mi">8</span><span class="p">,</span>
+ <span class="nt">"typeName"</span><span class="p">:</span> <span class="s2">"integer"</span><span class="p">,</span>
+ <span class="nt">"className"</span><span class="p">:</span> <span class="s2">"java.lang.Integer"</span><span class="p">,</span>
+ <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"number"</span>
+<span class="p">}</span></code></pre></div>
+
+<p><code>signed</code> A boolean denoting whether the column is a signed numeric.</p>
+
+<p><code>precision</code> The maximum numeric precision supported by this column.</p>
+
+<p><code>scale</code> The maximum numeric scale supported by this column.</p>
+
+<p><code>parameterType</code> An integer corresponding to the JDBC Types class denoting the columnâs type.</p>
+
+<p><code>typeName</code> The JDBC type name for this column.</p>
+
+<p><code>className</code> The Java class backing the JDBC type for this column.</p>
+
+<p><code>name</code> The name of the column.</p>
+
+<h3 id="avaticatype">AvaticaType</h3>
+
+<div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
+ <span class="nt">"type"</span><span class="p">:</span> <span class="s2">"scalar"</span><span class="p">,</span>
+ <span class="nt">"id"</span><span class="p">:</span> <span class="s2">"identifier"</span><span class="p">,</span>
+ <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"column"</span><span class="p">,</span>
+ <span class="nt">"rep"</span><span class="p">:</span> <span class="err">Rep</span><span class="p">,</span>
+ <span class="nt">"columns"</span><span class="p">:</span> <span class="p">[</span> <span class="err">ColumnMetaData</span><span class="p">,</span> <span class="err">ColumnMetaData</span><span class="p">,</span> <span class="err">...</span> <span class="p">],</span>
+ <span class="nt">"component"</span><span class="p">:</span> <span class="err">AvaticaType</span>
+<span class="p">}</span></code></pre></div>
+
+<p><code>type</code> One of: <code>scalar</code>, <code>array</code>, <code>struct</code>.</p>
+
+<p><code>id</code> A numeric value corresponding to the type of the object per the JDBC Types class.</p>
+
+<p><code>name</code> The readable name of the JDBC type.</p>
+
+<p><code>rep</code> A nested <a href="#rep">Rep</a> object used by Avatica to hold additional type information.</p>
+
+<p><code>columns</code> For <code>STRUCT</code> types, a list of the columns contained in that <code>STRUCT</code>.</p>
+
+<p><code>component</code> For <code>ARRAY</code> types, the type of the elements contained in that <code>ARRAY</code>.</p>
+
+<h3 id="rep">Rep</h3>
+
+<p>One of:</p>
+
+<ul>
+ <li>âPRIMITIVE_BOOLEANâ</li>
+ <li>âPRIMITIVE_BYTEâ</li>
+ <li>âPRIMITIVE_CHARâ</li>
+ <li>âPRIMITIVE_SHORTâ</li>
+ <li>âPRIMITIVE_INTâ</li>
+ <li>âPRIMITIVE_LONGâ</li>
+ <li>âPRIMITIVE_FLOATâ</li>
+ <li>âPRIMITIVE_DOUBLEâ</li>
+ <li>âBOOLEANâ</li>
+ <li>âBYTEâ</li>
+ <li>âCHARACTERâ</li>
+ <li>âSHORTâ</li>
+ <li>âINTEGERâ</li>
+ <li>âLONGâ</li>
+ <li>âFLOATâ</li>
+ <li>âDOUBLEâ</li>
+ <li>âJAVA_SQL_TIMEâ</li>
+ <li>âJAVA_SQL_TIMESTAMPâ</li>
+ <li>âJAVA_SQL_DATEâ</li>
+ <li>âJAVA_UTIL_DATEâ</li>
+ <li>âBYTE_STRINGâ</li>
+ <li>âSTRINGâ</li>
+ <li>âNUMBERâ</li>
+ <li>âOBJECTâ</li>
+</ul>
+
+<h3 id="cursorfactory">CursorFactory</h3>
+
+<div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
+ <span class="nt">"style"</span><span class="p">:</span> <span class="err">Style</span><span class="p">,</span>
+ <span class="nt">"clazz"</span><span class="p">:</span> <span class="s2">"java.lang.String"</span><span class="p">,</span>
+ <span class="nt">"fieldNames"</span><span class="p">:</span> <span class="p">[</span> <span class="s2">"column1"</span><span class="p">,</span> <span class="s2">"column2"</span><span class="p">,</span> <span class="err">...</span> <span class="p">]</span>
+<span class="p">}</span></code></pre></div>
+
+<p><code>style</code> A string denoting the <a href="#style">Style</a> of the contained objects.</p>
+
+<h3 id="style">Style</h3>
+
+<p>One of:</p>
+
+<ul>
+ <li>âOBJECTâ</li>
+ <li>âRECORDâ</li>
+ <li>âRECORD_PROJECTIONâ</li>
+ <li>âARRAYâ</li>
+ <li>âLISTâ</li>
+ <li>âMAPâ</li>
+</ul>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="section-nav">
+ <div class="left align-right">
+
+
+
+ <a href="/docs/avatica_roadmap.html" class="prev">Previous</a>
+
+ </div>
+ <div class="right align-left">
+
+
+
+ <a href="/docs/reference.html" class="next">Next</a>
+
+ </div>
+ </div>
+ <div class="clear"></div>
+
+
+ </article>
+ </div>
+
+ <div class="unit one-fifth hide-on-mobiles">
+ <aside>
+
+ <h4>Overview</h4>
+
+
+<ul>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class=""><a href="/docs/index.html">Background</a></li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class=""><a href="/docs/tutorial.html">Tutorial</a></li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class=""><a href="/docs/algebra.html">Algebra</a></li>
+
+
+
+</ul>
+
+
+ <h4>Advanced</h4>
+
+
+<ul>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class=""><a href="/docs/adapter.html">Adapters</a></li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class=""><a href="/docs/stream.html">Streaming</a></li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class=""><a href="/docs/lattice.html">Lattices</a></li>
+
+
+
+</ul>
+
+
+ <h4>Avatica</h4>
+
+
+<ul>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class=""><a href="/docs/avatica_overview.html">Overview</a></li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class=""><a href="/docs/avatica_roadmap.html">Roadmap</a></li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="current"><a href="/docs/avatica_json_reference.html">JSON Reference</a></li>
+
+
+
+</ul>
+
+
+ <h4>Reference</h4>
+
+
+<ul>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class=""><a href="/docs/reference.html">SQL language</a></li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class=""><a href="/docs/model.html">JSON models</a></li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class=""><a href="/docs/howto.html">HOWTO</a></li>
+
+
+
+</ul>
+
+
+ <h4>Meta</h4>
+
+
+<ul>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class=""><a href="/docs/downloads.html">Downloads</a></li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class=""><a href="/docs/history.html">History</a></li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class=""><a href="/docs/contributing.html">Contributing</a></li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class=""><a href="/docs/api.html">API</a></li>
+
+
+
+</ul>
+
+
+ </aside>
+</div>
+
+
+ <div class="clear"></div>
+
+ </div>
+ </section>
+
+
+ <footer role="contentinfo">
+ <p>The contents of this website are © 2015
+ <a href="https://www.apache.org/">Apache Software Foundation</a>
+ under the terms of
+ the <a href="https://www.apache.org/licenses/LICENSE-2.0.html">
+ Apache License v2</a>. Apache Calcite and its logo are
+ trademarks of the Apache Software Foundation.</p>
+</footer>
+
+ <script>
+ var anchorForId = function (id) {
+ var anchor = document.createElement("a");
+ anchor.className = "header-link";
+ anchor.href = "#" + id;
+ anchor.innerHTML = "<span class=\"sr-only\">Permalink</span><i class=\"fa fa-link\"></i>";
+ anchor.title = "Permalink";
+ return anchor;
+ };
+
+ var linkifyAnchors = function (level, containingElement) {
+ var headers = containingElement.getElementsByTagName("h" + level);
+ for (var h = 0; h < headers.length; h++) {
+ var header = headers[h];
+
+ if (typeof header.id !== "undefined" && header.id !== "") {
+ header.appendChild(anchorForId(header.id));
+ }
+ }
+ };
+
+ document.onreadystatechange = function () {
+ if (this.readyState === "complete") {
+ var contentBlock = document.getElementsByClassName("docs")[0] || document.getElementsByClassName("news")[0];
+ if (!contentBlock) {
+ return;
+ }
+ for (var level = 1; level <= 6; level++) {
+ linkifyAnchors(level, contentBlock);
+ }
+ }
+ };
+</script>
+
+
+</body>
+</html>