calcite-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From els...@apache.org
Subject svn commit: r1721255 [1/3] - /calcite/site/docs/
Date Mon, 21 Dec 2015 20:16:32 GMT
Author: elserj
Date: Mon Dec 21 20:16:32 2015
New Revision: 1721255

URL: http://svn.apache.org/viewvc?rev=1721255&view=rev
Log:
[CALCITE-984] [CALCITE-1029] [CALCITE-1033] Updating Avatica docs

Added:
    calcite/site/docs/avatica_protobuf_reference.html
Modified:
    calcite/site/docs/adapter.html
    calcite/site/docs/algebra.html
    calcite/site/docs/avatica_json_reference.html
    calcite/site/docs/avatica_overview.html
    calcite/site/docs/avatica_roadmap.html
    calcite/site/docs/history.html
    calcite/site/docs/howto.html
    calcite/site/docs/index.html
    calcite/site/docs/lattice.html
    calcite/site/docs/model.html
    calcite/site/docs/reference.html
    calcite/site/docs/stream.html
    calcite/site/docs/tutorial.html

Modified: calcite/site/docs/adapter.html
URL: http://svn.apache.org/viewvc/calcite/site/docs/adapter.html?rev=1721255&r1=1721254&r2=1721255&view=diff
==============================================================================
--- calcite/site/docs/adapter.html (original)
+++ calcite/site/docs/adapter.html Mon Dec 21 20:16:32 2015
@@ -120,6 +120,8 @@
   
     
   
+    
+  
 
   
 
@@ -154,6 +156,8 @@
   
     
   
+    
+  
 
   
 
@@ -188,6 +192,8 @@
   
     
   
+    
+  
 
 
     </optgroup>
@@ -229,6 +235,8 @@
   
     
   
+    
+  
 
   
 
@@ -263,6 +271,8 @@
   
     
   
+    
+  
 
   
 
@@ -297,6 +307,8 @@
   
     
   
+    
+  
 
 
     </optgroup>
@@ -338,6 +350,8 @@
   
     
   
+    
+  
 
   
 
@@ -372,6 +386,8 @@
   
     
   
+    
+  
 
   
 
@@ -406,6 +422,44 @@
   
     
   
+    
+  
+
+  
+
+  
+    
+  
+    
+  
+    
+  
+    
+  
+    
+  
+    
+  
+    
+  
+    
+  
+    
+  
+    
+  
+    
+  
+    
+  
+    
+  
+    
+  
+    
+  
+    
+  
 
 
     </optgroup>
@@ -447,6 +501,8 @@
   
     
   
+    
+  
 
   
 
@@ -481,6 +537,8 @@
   
     
   
+    
+  
 
   
 
@@ -515,6 +573,8 @@
   
     
   
+    
+  
 
 
     </optgroup>
@@ -556,6 +616,8 @@
   
     
   
+    
+  
 
   
 
@@ -590,6 +652,8 @@
   
     
   
+    
+  
 
   
 
@@ -624,6 +688,8 @@
   
     
   
+    
+  
 
 
     </optgroup>
@@ -766,6 +832,12 @@
       
     
     
+  
+    
+    
+      
+    
+    
       <li class=""><a href="/docs/index.html">Background</a></li>
       
 
@@ -868,6 +940,12 @@
       
     
     
+  
+    
+    
+      
+    
+    
       <li class=""><a href="/docs/tutorial.html">Tutorial</a></li>
       
 
@@ -1008,6 +1086,12 @@
       
     
     
+  
+    
+    
+      
+    
+    
       <li class=""><a href="/docs/stream.html">Streaming</a></li>
       
 
@@ -1080,6 +1164,12 @@
       
     
     
+  
+    
+    
+      
+    
+    
       <li class=""><a href="/docs/lattice.html">Lattices</a></li>
       
 
@@ -1178,6 +1268,12 @@
       
     
     
+  
+    
+    
+      
+    
+    
       <li class=""><a href="/docs/avatica_roadmap.html">Roadmap</a></li>
       
 
@@ -1218,6 +1314,54 @@
       
 
 
+  
+  
+  
+
+  
+    
+  
+
+  
+    
+    
+      
+    
+    
+  
+    
+    
+      
+    
+    
+  
+    
+    
+      
+    
+    
+  
+    
+    
+      
+    
+    
+  
+    
+    
+      
+    
+    
+  
+    
+    
+      
+    
+    
+      <li class=""><a href="/docs/avatica_protobuf_reference.html">Protobuf Reference</a></li>
+      
+
+
 </ul>
 
     
@@ -1306,6 +1450,12 @@
       
     
     
+  
+    
+    
+      
+    
+    
       <li class=""><a href="/docs/reference.html">SQL language</a></li>
       
 
@@ -1384,6 +1534,12 @@
       
     
     
+  
+    
+    
+      
+    
+    
       <li class=""><a href="/docs/model.html">JSON models</a></li>
       
 
@@ -1444,6 +1600,12 @@
       
     
     
+  
+    
+    
+      
+    
+    
       <li class=""><a href="/docs/howto.html">HOWTO</a></li>
       
 
@@ -1506,6 +1668,12 @@
       
     
     
+  
+    
+    
+      
+    
+    
       <li class=""><a href="/docs/history.html">History</a></li>
       
 
@@ -1551,6 +1719,12 @@
   
     
     
+      
+    
+    
+  
+    
+    
       
     
     

Modified: calcite/site/docs/algebra.html
URL: http://svn.apache.org/viewvc/calcite/site/docs/algebra.html?rev=1721255&r1=1721254&r2=1721255&view=diff
==============================================================================
--- calcite/site/docs/algebra.html (original)
+++ calcite/site/docs/algebra.html Mon Dec 21 20:16:32 2015
@@ -120,6 +120,8 @@
   
     
   
+    
+  
 
   
 
@@ -154,6 +156,8 @@
   
     
   
+    
+  
 
   
 
@@ -188,6 +192,8 @@
   
     
   
+    
+  
 
 
     </optgroup>
@@ -229,6 +235,8 @@
   
     
   
+    
+  
 
   
 
@@ -263,6 +271,8 @@
   
     
   
+    
+  
 
   
 
@@ -297,6 +307,8 @@
   
     
   
+    
+  
 
 
     </optgroup>
@@ -338,6 +350,8 @@
   
     
   
+    
+  
 
   
 
@@ -372,6 +386,8 @@
   
     
   
+    
+  
 
   
 
@@ -406,6 +422,44 @@
   
     
   
+    
+  
+
+  
+
+  
+    
+  
+    
+  
+    
+  
+    
+  
+    
+  
+    
+  
+    
+  
+    
+  
+    
+  
+    
+  
+    
+  
+    
+  
+    
+  
+    
+  
+    
+  
+    
+  
 
 
     </optgroup>
@@ -447,6 +501,8 @@
   
     
   
+    
+  
 
   
 
@@ -481,6 +537,8 @@
   
     
   
+    
+  
 
   
 
@@ -515,6 +573,8 @@
   
     
   
+    
+  
 
 
     </optgroup>
@@ -556,6 +616,8 @@
   
     
   
+    
+  
 
   
 
@@ -590,6 +652,8 @@
   
     
   
+    
+  
 
   
 
@@ -624,6 +688,8 @@
   
     
   
+    
+  
 
 
     </optgroup>
@@ -1259,6 +1325,12 @@ added to the stack.</p>
       
     
     
+  
+    
+    
+      
+    
+    
       <li class=""><a href="/docs/index.html">Background</a></li>
       
 
@@ -1361,6 +1433,12 @@ added to the stack.</p>
       
     
     
+  
+    
+    
+      
+    
+    
       <li class=""><a href="/docs/tutorial.html">Tutorial</a></li>
       
 
@@ -1501,6 +1579,12 @@ added to the stack.</p>
       
     
     
+  
+    
+    
+      
+    
+    
       <li class=""><a href="/docs/stream.html">Streaming</a></li>
       
 
@@ -1573,6 +1657,12 @@ added to the stack.</p>
       
     
     
+  
+    
+    
+      
+    
+    
       <li class=""><a href="/docs/lattice.html">Lattices</a></li>
       
 
@@ -1671,6 +1761,12 @@ added to the stack.</p>
       
     
     
+  
+    
+    
+      
+    
+    
       <li class=""><a href="/docs/avatica_roadmap.html">Roadmap</a></li>
       
 
@@ -1711,6 +1807,54 @@ added to the stack.</p>
       
 
 
+  
+  
+  
+
+  
+    
+  
+
+  
+    
+    
+      
+    
+    
+  
+    
+    
+      
+    
+    
+  
+    
+    
+      
+    
+    
+  
+    
+    
+      
+    
+    
+  
+    
+    
+      
+    
+    
+  
+    
+    
+      
+    
+    
+      <li class=""><a href="/docs/avatica_protobuf_reference.html">Protobuf Reference</a></li>
+      
+
+
 </ul>
 
     
@@ -1799,6 +1943,12 @@ added to the stack.</p>
       
     
     
+  
+    
+    
+      
+    
+    
       <li class=""><a href="/docs/reference.html">SQL language</a></li>
       
 
@@ -1877,6 +2027,12 @@ added to the stack.</p>
       
     
     
+  
+    
+    
+      
+    
+    
       <li class=""><a href="/docs/model.html">JSON models</a></li>
       
 
@@ -1937,6 +2093,12 @@ added to the stack.</p>
       
     
     
+  
+    
+    
+      
+    
+    
       <li class=""><a href="/docs/howto.html">HOWTO</a></li>
       
 
@@ -1999,6 +2161,12 @@ added to the stack.</p>
       
     
     
+  
+    
+    
+      
+    
+    
       <li class=""><a href="/docs/history.html">History</a></li>
       
 
@@ -2044,6 +2212,12 @@ added to the stack.</p>
   
     
     
+      
+    
+    
+  
+    
+    
       
     
     

Modified: calcite/site/docs/avatica_json_reference.html
URL: http://svn.apache.org/viewvc/calcite/site/docs/avatica_json_reference.html?rev=1721255&r1=1721254&r2=1721255&view=diff
==============================================================================
--- calcite/site/docs/avatica_json_reference.html (original)
+++ calcite/site/docs/avatica_json_reference.html Mon Dec 21 20:16:32 2015
@@ -120,6 +120,8 @@
   
     
   
+    
+  
 
   
 
@@ -154,6 +156,8 @@
   
     
   
+    
+  
 
   
 
@@ -188,6 +192,8 @@
   
     
   
+    
+  
 
 
     </optgroup>
@@ -229,6 +235,8 @@
   
     
   
+    
+  
 
   
 
@@ -263,6 +271,8 @@
   
     
   
+    
+  
 
   
 
@@ -297,6 +307,8 @@
   
     
   
+    
+  
 
 
     </optgroup>
@@ -338,6 +350,8 @@
   
     
   
+    
+  
 
   
 
@@ -372,6 +386,8 @@
   
     
   
+    
+  
 
   
 
@@ -406,6 +422,44 @@
   
     
   
+    
+  
+
+  
+
+  
+    
+  
+    
+  
+    
+  
+    
+  
+    
+  
+    
+  
+    
+  
+    
+  
+    
+  
+    
+  
+    
+  
+    
+  
+    
+  
+    
+  
+    
+  
+    
+  
 
 
     </optgroup>
@@ -447,6 +501,8 @@
   
     
   
+    
+  
 
   
 
@@ -481,6 +537,8 @@
   
     
   
+    
+  
 
   
 
@@ -515,6 +573,8 @@
   
     
   
+    
+  
 
 
     </optgroup>
@@ -556,6 +616,8 @@
   
     
   
+    
+  
 
   
 
@@ -590,6 +652,8 @@
   
     
   
+    
+  
 
   
 
@@ -624,6 +688,8 @@
   
     
   
+    
+  
 
 
     </optgroup>
@@ -646,25 +712,24 @@ using any language instead of being limi
 
 <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>
+in Java. For support outside of Java, see the Protocol Buffer
+<a href="/docs/avatica_protobuf_reference.html">bindings</a></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>
+  <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="#commitrequest">CommitRequest</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="#executerequest">ExecuteRequest</a></li><li><a href="#fetchrequest">FetchRequest</a></li><li><a href="#openconnectionrequest">OpenConnectionRequest</a></li><li><a href="#prepareandexecuterequest">PrepareAndExecuteRequest</a></li><li><a href="#preparerequest">PrepareRequest</a></li><li><a href="#rollbackrequest">RollbackRequest</a></li><li><a href="#schemasrequest">SchemasRequest</a></li><li><a href="#syncresultsrequest">SyncResultsRequest</a></li><li><a href="#tabletypesreque
 st">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>
+  <li><a href="#closeconnectionresponse">CloseConnectionResponse</a></li><li><a href="#closestatementresponse">CloseStatementResponse</a></li><li><a href="#commitresponse">CommitResponse</a></li><li><a href="#connectionsyncresponse">ConnectionSyncResponse</a></li><li><a href="#createstatementresponse">CreateStatementResponse</a></li><li><a href="#databasepropertyresponse">DatabasePropertyResponse</a></li><li><a href="#errorresponse">ErrorResponse</a></li><li><a href="#executeresponse">ExecuteResponse</a></li><li><a href="#fetchresponse">FetchResponse</a></li><li><a href="#openconnectionresponse">OpenConnectionResponse</a></li><li><a href="#prepareresponse">PrepareResponse</a></li><li><a href="#resultsetresponse">ResultSetResponse</a></li><li><a href="#rollbackresponse">RollbackResponse</a></li><li><a href="#syncresultsresponse">SyncResultsResponse</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>
+  <li><a href="#avaticaparameter">AvaticaParameter</a></li><li><a href="#avaticaseverity">AvaticaSeverity</a></li><li><a href="#avaticatype">AvaticaType</a></li><li><a href="#columnmetadata">ColumnMetaData</a></li><li><a href="#connectionproperties">ConnectionProperties</a></li><li><a href="#cursorfactory">CursorFactory</a></li><li><a href="#databaseproperty">DatabaseProperty</a></li><li><a href="#frame">Frame</a></li><li><a href="#querystate">QueryState</a></li><li><a href="#rep">Rep</a></li><li><a href="#rpcmetadata">RpcMetadata</a></li><li><a href="#signature">Signature</a></li><li><a href="#statetype">StateType</a></li><li><a href="#statementhandle">StatementHandle</a></li><li><a href="#statementtype">StatementType</a></li><li><a href="#style">Style</a></li><li><a href="#typedvalue">TypedValue</a></li>
 </ul>
 
 <h2 id="requests-1">Requests</h2>
@@ -674,14 +739,19 @@ which uniquely identifies the concrete R
 
 <h3 id="catalogsrequest">CatalogsRequest</h3>
 
+<p>This request is used to fetch the available catalog names in the database.</p>
+
 <div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
   <span class="nt">&quot;request&quot;</span><span class="p">:</span> <span class="s2">&quot;getCatalogs&quot;</span><span class="p">,</span>
+  <span class="nt">&quot;connectionId&quot;</span><span class="p">:</span> <span class="s2">&quot;000000-0000-0000-00000000&quot;</span>
 <span class="p">}</span></code></pre></div>
 
-<p>There are no extra attributes on this Request.</p>
+<p><code>connectionId</code> (required string) The identifier of the connection to use.</p>
 
 <h3 id="closeconnectionrequest">CloseConnectionRequest</h3>
 
+<p>This request is used to close the Connection object in the Avatica server identified by the given IDs.</p>
+
 <div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
   <span class="nt">&quot;request&quot;</span><span class="p">:</span> <span class="s2">&quot;closeConnection&quot;</span><span class="p">,</span>
   <span class="nt">&quot;connectionId&quot;</span><span class="p">:</span> <span class="s2">&quot;000000-0000-0000-00000000&quot;</span>
@@ -691,6 +761,8 @@ which uniquely identifies the concrete R
 
 <h3 id="closestatementrequest">CloseStatementRequest</h3>
 
+<p>This request is used to close the Statement object in the Avatica server identified by the given IDs.</p>
+
 <div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
   <span class="nt">&quot;request&quot;</span><span class="p">:</span> <span class="s2">&quot;closeStatement&quot;</span><span class="p">,</span>
   <span class="nt">&quot;connectionId&quot;</span><span class="p">:</span> <span class="s2">&quot;000000-0000-0000-00000000&quot;</span><span class="p">,</span>
@@ -703,14 +775,19 @@ which uniquely identifies the concrete R
 
 <h3 id="columnsrequest">ColumnsRequest</h3>
 
+<p>This request is used to fetch columns in the database given some optional filtering criteria.</p>
+
 <div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
   <span class="nt">&quot;request&quot;</span><span class="p">:</span> <span class="s2">&quot;getColumns&quot;</span><span class="p">,</span>
+  <span class="nt">&quot;connectionId&quot;</span><span class="p">:</span> <span class="s2">&quot;000000-0000-0000-00000000&quot;</span><span class="p">,</span>
   <span class="nt">&quot;catalog&quot;</span><span class="p">:</span> <span class="s2">&quot;catalog&quot;</span><span class="p">,</span>
   <span class="nt">&quot;schemaPattern&quot;</span><span class="p">:</span> <span class="s2">&quot;schema_pattern.*&quot;</span><span class="p">,</span>
   <span class="nt">&quot;tableNamePattern&quot;</span><span class="p">:</span> <span class="s2">&quot;table_pattern.*&quot;</span><span class="p">,</span>
   <span class="nt">&quot;columnNamePattern&quot;</span><span class="p">:</span> <span class="s2">&quot;column_pattern.*&quot;</span>
 <span class="p">}</span></code></pre></div>
 
+<p><code>connectionId</code> (required string) The identifier of the connection on which to fetch the columns.</p>
+
 <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>
@@ -719,8 +796,21 @@ which uniquely identifies the concrete R
 
 <p><code>columnNamePattern</code> (optional string) A Java Pattern against column names to limit returned columns.</p>
 
+<h3 id="commitrequest">CommitRequest</h3>
+
+<p>This request is used to issue a <code>commit</code> on the Connection in the Avatica server identified by the given ID.</p>
+
+<div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
+  <span class="nt">&quot;request&quot;</span><span class="p">:</span> <span class="s2">&quot;commit&quot;</span><span class="p">,</span>
+  <span class="nt">&quot;connectionId&quot;</span><span class="p">:</span> <span class="s2">&quot;000000-0000-0000-00000000&quot;</span>
+<span class="p">}</span></code></pre></div>
+
+<p><code>connectionId</code> (required string) The identifier of the connection on which to invoke commit.</p>
+
 <h3 id="connectionsyncrequest">ConnectionSyncRequest</h3>
 
+<p>This request is used to ensure that the client and server have a consistent view of the database properties.</p>
+
 <div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
   <span class="nt">&quot;request&quot;</span><span class="p">:</span> <span class="s2">&quot;connectionSync&quot;</span><span class="p">,</span>
   <span class="nt">&quot;connectionId&quot;</span><span class="p">:</span> <span class="s2">&quot;000000-0000-0000-00000000&quot;</span><span class="p">,</span>
@@ -733,6 +823,8 @@ which uniquely identifies the concrete R
 
 <h3 id="createstatementrequest">CreateStatementRequest</h3>
 
+<p>This request is used to create a new Statement in the Avatica server.</p>
+
 <div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
   <span class="nt">&quot;request&quot;</span><span class="p">:</span> <span class="s2">&quot;createStatement&quot;</span><span class="p">,</span>
   <span class="nt">&quot;connectionId&quot;</span><span class="p">:</span> <span class="s2">&quot;000000-0000-0000-00000000&quot;</span>
@@ -742,21 +834,41 @@ which uniquely identifies the concrete R
 
 <h3 id="databasepropertyrequest">DatabasePropertyRequest</h3>
 
+<p>This request is used to fetch all <a href="#databaseproperty">database properties</a>.</p>
+
 <div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
   <span class="nt">&quot;request&quot;</span><span class="p">:</span> <span class="s2">&quot;databaseProperties&quot;</span><span class="p">,</span>
 <span class="p">}</span></code></pre></div>
 
-<p>There are no extra attributes on this Request.</p>
+<p><code>connectionId</code> (required string) The identifier of the connection to use when fetching the database properties.</p>
+
+<h3 id="executerequest">ExecuteRequest</h3>
+
+<p>This request is used to execute a PreparedStatement, optionally with values to bind to the parameters in the Statement.</p>
+
+<div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
+  <span class="nt">&quot;request&quot;</span><span class="p">:</span> <span class="s2">&quot;execute&quot;</span><span class="p">,</span>
+  <span class="nt">&quot;statementHandle&quot;</span><span class="p">:</span> <span class="err">StatementHandle</span><span class="p">,</span>
+  <span class="nt">&quot;parameterValues&quot;</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="nt">&quot;maxRowCount&quot;</span><span class="p">:</span> <span class="mi">100</span>
+<span class="p">}</span></code></pre></div>
+
+<p><code>statementHandle</code> (required object) A <a href="#statementhandle">StatementHandle</a> object.</p>
+
+<p><code>parameterValues</code> (optional array of nested objects) The <a href="#typedvalue">TypedValue</a> for each parameter on the prepared statement.</p>
+
+<p><code>maxRowCount</code> (required long) The maximum number of rows returned in the response.</p>
 
 <h3 id="fetchrequest">FetchRequest</h3>
 
+<p>This request is used to fetch a batch of rows from a Statement previously created.</p>
+
 <div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
   <span class="nt">&quot;request&quot;</span><span class="p">:</span> <span class="s2">&quot;fetch&quot;</span><span class="p">,</span>
   <span class="nt">&quot;connectionId&quot;</span><span class="p">:</span> <span class="s2">&quot;000000-0000-0000-00000000&quot;</span><span class="p">,</span>
   <span class="nt">&quot;statementId&quot;</span><span class="p">:</span> <span class="mi">12345</span><span class="p">,</span>
   <span class="nt">&quot;offset&quot;</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
-  <span class="nt">&quot;fetchMaxRowCount&quot;</span><span class="p">:</span> <span class="mi">100</span><span class="p">,</span>
-  <span class="nt">&quot;parameterValues&quot;</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="nt">&quot;fetchMaxRowCount&quot;</span><span class="p">:</span> <span class="mi">100</span>
 <span class="p">}</span></code></pre></div>
 
 <p><code>connectionId</code> (required string) The identifier of the connection to use.</p>
@@ -767,10 +879,24 @@ which uniquely identifies the concrete R
 
 <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="openconnectionrequest">OpenConnectionRequest</h3>
+
+<p>This request is used to open a new Connection in the Avatica server.</p>
+
+<div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
+  <span class="nt">&quot;request&quot;</span><span class="p">:</span> <span class="s2">&quot;openConnection&quot;</span><span class="p">,</span>
+  <span class="nt">&quot;connectionId&quot;</span><span class="p">:</span> <span class="s2">&quot;000000-0000-0000-00000000&quot;</span><span class="p">,</span>
+  <span class="nt">&quot;info&quot;</span><span class="p">:</span> <span class="p">{</span><span class="nt">&quot;key&quot;</span><span class="p">:</span><span class="s2">&quot;value&quot;</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 open in the server.</p>
+
+<p><code>info</code> (optional string-to-string map) A Map containing properties to include when creating the Connection.</p>
 
 <h3 id="prepareandexecuterequest">PrepareAndExecuteRequest</h3>
 
+<p>This request is used as a short-hand for create a Statement and fetching the first batch of results in a single call without any parameter substitution.</p>
+
 <div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
   <span class="nt">&quot;request&quot;</span><span class="p">:</span> <span class="s2">&quot;prepareAndExecute&quot;</span><span class="p">,</span>
   <span class="nt">&quot;connectionId&quot;</span><span class="p">:</span> <span class="s2">&quot;000000-0000-0000-00000000&quot;</span><span class="p">,</span>
@@ -789,6 +915,8 @@ which uniquely identifies the concrete R
 
 <h3 id="preparerequest">PrepareRequest</h3>
 
+<p>This request is used to create create a new Statement with the given query in the Avatica server.</p>
+
 <div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
   <span class="nt">&quot;request&quot;</span><span class="p">:</span> <span class="s2">&quot;prepare&quot;</span><span class="p">,</span>
   <span class="nt">&quot;connectionId&quot;</span><span class="p">:</span> <span class="s2">&quot;000000-0000-0000-00000000&quot;</span><span class="p">,</span>
@@ -802,30 +930,72 @@ which uniquely identifies the concrete R
 
 <p><code>maxRowCount</code> (required long) The maximum number of rows returned in the response.</p>
 
+<h3 id="syncresultsrequest">SyncResultsRequest</h3>
+
+<p>This request is used to reset a ResultSet’s iterator to a specific offset in the Avatica server.</p>
+
+<div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
+  <span class="nt">&quot;request&quot;</span><span class="p">:</span> <span class="s2">&quot;syncResults&quot;</span><span class="p">,</span>
+  <span class="nt">&quot;connectionId&quot;</span><span class="p">:</span> <span class="s2">&quot;000000-0000-0000-00000000&quot;</span><span class="p">,</span>
+  <span class="nt">&quot;statementId&quot;</span><span class="p">:</span> <span class="mi">12345</span><span class="p">,</span>
+  <span class="nt">&quot;state&quot;</span><span class="p">:</span> <span class="err">QueryState</span><span class="p">,</span>
+  <span class="nt">&quot;offset&quot;</span><span class="p">:</span> <span class="mi">200</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 to use.</p>
+
+<p><code>state</code> (required object) The <a href="#querystate">QueryState</a> object.</p>
+
+<p><code>offset</code> (required long) The offset into the ResultSet to seek to.</p>
+
+<h3 id="rollbackrequest">RollbackRequest</h3>
+
+<p>This request is used to issue a <code>rollback</code> on the Connection in the Avatica server identified by the given ID.</p>
+
+<div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
+  <span class="nt">&quot;request&quot;</span><span class="p">:</span> <span class="s2">&quot;rollback&quot;</span><span class="p">,</span>
+  <span class="nt">&quot;connectionId&quot;</span><span class="p">:</span> <span class="s2">&quot;000000-0000-0000-00000000&quot;</span>
+<span class="p">}</span></code></pre></div>
+
+<p><code>connectionId</code> (required string) The identifier for the connection on which to invoke rollback.</p>
+
 <h3 id="schemasrequest">SchemasRequest</h3>
 
+<p>This request is used to fetch the schemas matching the provided criteria in the database.</p>
+
 <div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
   <span class="nt">&quot;request&quot;</span><span class="p">:</span> <span class="s2">&quot;getSchemas&quot;</span><span class="p">,</span>
+  <span class="nt">&quot;connectionId&quot;</span><span class="p">:</span> <span class="s2">&quot;000000-0000-0000-00000000&quot;</span><span class="p">,</span>
   <span class="nt">&quot;catalog&quot;</span><span class="p">:</span> <span class="s2">&quot;name&quot;</span><span class="p">,</span>
   <span class="nt">&quot;schemaPattern&quot;</span><span class="p">:</span> <span class="s2">&quot;pattern.*&quot;</span>
 <span class="p">}</span></code></pre></div>
 
+<p><code>connection_id</code> The identifier for the connection to fetch schemas from.</p>
+
 <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>
 
+<p>This request is used to fetch the table types available in this database.</p>
+
 <div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
   <span class="nt">&quot;request&quot;</span><span class="p">:</span> <span class="s2">&quot;getTableTypes&quot;</span><span class="p">,</span>
+  <span class="nt">&quot;connectionId&quot;</span><span class="p">:</span> <span class="s2">&quot;000000-0000-0000-00000000&quot;</span>
 <span class="p">}</span></code></pre></div>
 
-<p>There are no extra attributes on this Request.</p>
+<p><code>connectionId</code> The identifier of the connection to fetch the table types from.</p>
 
 <h3 id="tablesrequest">TablesRequest</h3>
 
+<p>This request is used to fetch the tables available in this database filtered by the provided criteria.</p>
+
 <div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
   <span class="nt">&quot;request&quot;</span><span class="p">:</span> <span class="s2">&quot;getTables&quot;</span><span class="p">,</span>
+  <span class="nt">&quot;connectionId&quot;</span><span class="p">:</span> <span class="s2">&quot;000000-0000-0000-00000000&quot;</span><span class="p">,</span>
   <span class="nt">&quot;catalog&quot;</span><span class="p">:</span> <span class="s2">&quot;catalog_name&quot;</span><span class="p">,</span>
   <span class="nt">&quot;schemaPattern&quot;</span><span class="p">:</span> <span class="s2">&quot;schema_pattern.*&quot;</span><span class="p">,</span>
   <span class="nt">&quot;tableNamePattern&quot;</span><span class="p">:</span> <span class="s2">&quot;table_name_pattern.*&quot;</span><span class="p">,</span>
@@ -834,6 +1004,8 @@ which uniquely identifies the concrete R
 
 <p><code>catalog</code> (optional string) The name of a catalog to restrict fetched tables.</p>
 
+<p><code>connectionId</code> The identifier of the connection to fetch the tables from.</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>
@@ -842,216 +1014,326 @@ which uniquely identifies the concrete R
 
 <h3 id="typeinforequest">TypeInfoRequest</h3>
 
+<p>This request is used to fetch the types available in this database.</p>
+
 <div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
   <span class="nt">&quot;request&quot;</span><span class="p">:</span> <span class="s2">&quot;getTypeInfo&quot;</span><span class="p">,</span>
+  <span class="nt">&quot;connectionId&quot;</span><span class="p">:</span> <span class="s2">&quot;000000-0000-0000-00000000&quot;</span>
 <span class="p">}</span></code></pre></div>
 
-<p>There are no extra attributes on this Request.</p>
+<p><code>connectionId</code> The identifier of the connection to fetch the types from.</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>
+<h3 id="closeconnectionresponse">CloseConnectionResponse</h3>
+
+<p>A response to the <a href="#closeconnectionrequest">CloseConnectionRequest</a>.</p>
 
 <div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
-  <span class="nt">&quot;response&quot;</span><span class="p">:</span> <span class="s2">&quot;resultSet&quot;</span><span class="p">,</span>
-  <span class="nt">&quot;connectionId&quot;</span><span class="p">:</span> <span class="s2">&quot;000000-0000-0000-00000000&quot;</span><span class="p">,</span>
-  <span class="nt">&quot;statementId&quot;</span><span class="p">:</span> <span class="mi">12345</span><span class="p">,</span>
-  <span class="nt">&quot;ownStatement&quot;</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
-  <span class="nt">&quot;signature&quot;</span><span class="p">:</span> <span class="err">Signature</span><span class="p">,</span>
-  <span class="nt">&quot;firstFrame&quot;</span><span class="p">:</span> <span class="err">Frame</span><span class="p">,</span>
-  <span class="nt">&quot;updateCount&quot;</span><span class="p">:</span> <span class="mi">10</span>
+  <span class="nt">&quot;response&quot;</span><span class="p">:</span> <span class="s2">&quot;closeConnection&quot;</span><span class="p">,</span>
+  <span class="nt">&quot;rpcMetadata&quot;</span><span class="p">:</span> <span class="err">RpcMetadata</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>rpcMetadata</code> <a href="#rpcmetadata">Server metadata</a> about this call.</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="closestatementresponse">CloseStatementResponse</h3>
 
-<h3 id="executeresponse">ExecuteResponse</h3>
+<p>A response to the <a href="#closestatementrequest">CloseStatementRequest</a>.</p>
 
 <div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
-  <span class="nt">&quot;response&quot;</span><span class="p">:</span> <span class="s2">&quot;executeResults&quot;</span><span class="p">,</span>
-  <span class="nt">&quot;resultSets&quot;</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="nt">&quot;response&quot;</span><span class="p">:</span> <span class="s2">&quot;closeStatement&quot;</span><span class="p">,</span>
+  <span class="nt">&quot;rpcMetadata&quot;</span><span class="p">:</span> <span class="err">RpcMetadata</span>
 <span class="p">}</span></code></pre></div>
 
-<p><code>resultSets</code> An array of <a href="#resultsetresponse">ResultSetResponse</a>s.</p>
+<p><code>rpcMetadata</code> <a href="#rpcmetadata">Server metadata</a> about this call.</p>
 
-<h3 id="prepareresponse">PrepareResponse</h3>
+<h3 id="commitresponse">CommitResponse</h3>
+
+<p>A response to the <a href="#commitrequest">CommitRequest</a>.</p>
 
 <div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
-  <span class="nt">&quot;response&quot;</span><span class="p">:</span> <span class="s2">&quot;prepare&quot;</span><span class="p">,</span>
-  <span class="nt">&quot;statement&quot;</span><span class="p">:</span> <span class="err">StatementHandle</span>
+  <span class="nt">&quot;response&quot;</span><span class="p">:</span> <span class="s2">&quot;commit&quot;</span>
 <span class="p">}</span></code></pre></div>
 
-<p><code>statement</code> A <a href="#statementhandle">StatementHandle</a> object.</p>
+<p>There are no extra attributes on this Response.</p>
 
-<h3 id="fetchresponse">FetchResponse</h3>
+<h3 id="connectionsyncresponse">ConnectionSyncResponse</h3>
+
+<p>A response to the <a href="#connectionsyncrequest">ConnectionSyncRequest</a>. Properties included in the
+response are those of the Connection in the Avatica server.</p>
 
 <div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
-  <span class="nt">&quot;response&quot;</span><span class="p">:</span> <span class="s2">&quot;fetch&quot;</span><span class="p">,</span>
-  <span class="nt">&quot;frame&quot;</span><span class="p">:</span> <span class="err">Frame</span>
+  <span class="nt">&quot;response&quot;</span><span class="p">:</span> <span class="s2">&quot;connectionSync&quot;</span><span class="p">,</span>
+  <span class="nt">&quot;connProps&quot;</span><span class="p">:</span> <span class="err">ConnectionProperties</span><span class="p">,</span>
+  <span class="nt">&quot;rpcMetadata&quot;</span><span class="p">:</span> <span class="err">RpcMetadata</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>
+<p><code>connProps</code> The <a href="#connectionproperties">ConnectionProperties</a> that were synchronized.</p>
+
+<p><code>rpcMetadata</code> <a href="#rpcmetadata">Server metadata</a> about this call.</p>
 
 <h3 id="createstatementresponse">CreateStatementResponse</h3>
 
+<p>A response to the <a href="#createstatementrequest">CreateStatementRequest</a>. The ID of the statement
+that was created is included in the response. Clients will use this <code>statementId</code> in subsequent calls.</p>
+
 <div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
   <span class="nt">&quot;response&quot;</span><span class="p">:</span> <span class="s2">&quot;createStatement&quot;</span><span class="p">,</span>
   <span class="nt">&quot;connectionId&quot;</span><span class="p">:</span> <span class="s2">&quot;000000-0000-0000-00000000&quot;</span><span class="p">,</span>
-  <span class="nt">&quot;statementId&quot;</span><span class="p">:</span> <span class="mi">12345</span>
+  <span class="nt">&quot;statementId&quot;</span><span class="p">:</span> <span class="mi">12345</span><span class="p">,</span>
+  <span class="nt">&quot;rpcMetadata&quot;</span><span class="p">:</span> <span class="err">RpcMetadata</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>
+<p><code>rpcMetadata</code> <a href="#rpcmetadata">Server metadata</a> about this call.</p>
+
+<h3 id="databasepropertyresponse">DatabasePropertyResponse</h3>
+
+<p>A response to the <a href="#databasepropertyrequest">DatabasePropertyRequest</a>. See <a hred="#databaseproperty">DatabaseProperty</a>
+for information on the available property keys.</p>
 
 <div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
-  <span class="nt">&quot;response&quot;</span><span class="p">:</span> <span class="s2">&quot;closeStatement&quot;</span><span class="p">,</span>
+  <span class="nt">&quot;response&quot;</span><span class="p">:</span> <span class="s2">&quot;databaseProperties&quot;</span><span class="p">,</span>
+  <span class="nt">&quot;map&quot;</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="nt">&quot;rpcMetadata&quot;</span><span class="p">:</span> <span class="err">RpcMetadata</span>
 <span class="p">}</span></code></pre></div>
 
-<p>This response has no attributes.</p>
+<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>
 
-<h3 id="closeconnectionresponse">CloseConnectionResponse</h3>
+<p><code>rpcMetadata</code> <a href="#rpcmetadata">Server metadata</a> about this call.</p>
+
+<h3 id="errorresponse">ErrorResponse</h3>
+
+<p>A response when an error was caught executing a request. Any request may return this response.</p>
 
 <div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
-  <span class="nt">&quot;response&quot;</span><span class="p">:</span> <span class="s2">&quot;closeConnection&quot;</span><span class="p">,</span>
+  <span class="nt">&quot;response&quot;</span><span class="p">:</span> <span class="s2">&quot;error&quot;</span><span class="p">,</span>
+  <span class="nt">&quot;exceptions&quot;</span><span class="p">:</span> <span class="p">[</span> <span class="s2">&quot;stacktrace&quot;</span><span class="p">,</span> <span class="s2">&quot;stacktrace&quot;</span><span class="p">,</span> <span class="err">...</span> <span class="p">],</span>
+  <span class="nt">&quot;errorMessage&quot;</span><span class="p">:</span> <span class="s2">&quot;The error message&quot;</span><span class="p">,</span>
+  <span class="nt">&quot;errorCode&quot;</span><span class="p">:</span> <span class="mi">42</span><span class="p">,</span>
+  <span class="nt">&quot;sqlState&quot;</span><span class="p">:</span> <span class="s2">&quot;ABC12&quot;</span><span class="p">,</span>
+  <span class="nt">&quot;severity&quot;</span><span class="p">:</span> <span class="err">AvaticaSeverity</span><span class="p">,</span>
+  <span class="nt">&quot;rpcMetadata&quot;</span><span class="p">:</span> <span class="err">RpcMetadata</span>
 <span class="p">}</span></code></pre></div>
 
-<p>There are no extra attributes on this Response.</p>
+<p><code>exceptions</code> A list of stringified Java StackTraces.</p>
 
-<h3 id="connectionsyncresponse">ConnectionSyncResponse</h3>
+<p><code>errorMessage</code> A human-readable error message.</p>
 
-<div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
-  <span class="nt">&quot;response&quot;</span><span class="p">:</span> <span class="s2">&quot;connectionSync&quot;</span><span class="p">,</span>
-  <span class="nt">&quot;connProps&quot;</span><span class="p">:</span> <span class="err">ConnectionProperties</span>
-<span class="p">}</span></code></pre></div>
+<p><code>errorCode</code> A numeric code for this error.</p>
 
-<p><code>connProps</code> The <a href="#connectionproperties">ConnectionProperties</a> that were synchronized.</p>
+<p><code>sqlState</code> A five character alphanumeric code for this error.</p>
 
-<h3 id="databasepropertyresponse">DatabasePropertyResponse</h3>
+<p><code>severity</code> An <a href="#avaticaseverity">AvaticaSeverity</a> object which denotes how critical the error is.</p>
+
+<p><code>rpcMetadata</code> <a href="#rpcmetadata">Server metadata</a> about this call.</p>
+
+<h3 id="executeresponse">ExecuteResponse</h3>
+
+<p>A response to the <a href="#executerequest">ExecuteRequest</a> which contains the results for a metadata query.</p>
 
 <div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
-  <span class="nt">&quot;response&quot;</span><span class="p">:</span> <span class="s2">&quot;databaseProperties&quot;</span><span class="p">,</span>
-  <span class="nt">&quot;map&quot;</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="nt">&quot;response&quot;</span><span class="p">:</span> <span class="s2">&quot;executeResults&quot;</span><span class="p">,</span>
+  <span class="nt">&quot;resultSets&quot;</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="nt">&quot;missingStatement&quot;</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
+  <span class="nt">&quot;rpcMetadata&quot;</span><span class="p">:</span> <span class="err">RpcMetadata</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>
+<p><code>resultSets</code> An array of <a href="#resultsetresponse">ResultSetResponse</a>s.</p>
 
-<h2 id="miscellaneous-1">Miscellaneous</h2>
+<p><code>missingStatement</code> A boolean which denotes if the request failed due to a missing Statement.</p>
 
-<h3 id="connectionproperties">ConnectionProperties</h3>
+<p><code>rpcMetadata</code> <a href="#rpcmetadata">Server metadata</a> about this call.</p>
+
+<h3 id="fetchresponse">FetchResponse</h3>
+
+<p>A response to the <a href="#fetchrequest">FetchRequest</a> which contains the request for the query.</p>
 
 <div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
-  <span class="nt">&quot;connProps&quot;</span><span class="p">:</span> <span class="s2">&quot;connPropsImpl&quot;</span><span class="p">,</span>
-  <span class="nt">&quot;autoCommit&quot;</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
-  <span class="nt">&quot;readOnly&quot;</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
-  <span class="nt">&quot;transactionIsolation&quot;</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
-  <span class="nt">&quot;catalog&quot;</span><span class="p">:</span> <span class="s2">&quot;catalog&quot;</span><span class="p">,</span>
-  <span class="nt">&quot;schema&quot;</span><span class="p">:</span> <span class="s2">&quot;schema&quot;</span>
+  <span class="nt">&quot;response&quot;</span><span class="p">:</span> <span class="s2">&quot;fetch&quot;</span><span class="p">,</span>
+  <span class="nt">&quot;frame&quot;</span><span class="p">:</span> <span class="err">Frame</span><span class="p">,</span>
+  <span class="nt">&quot;missingStatement&quot;</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
+  <span class="nt">&quot;missingResults&quot;</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
+  <span class="nt">&quot;rpcMetadata&quot;</span><span class="p">:</span> <span class="err">RpcMetadata</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>frame</code> A <a href="#frame">Frame</a> containing the results of the fetch.</p>
 
-<p><code>readOnly</code> (optional boolean) A boolean denoting if a JDBC connection is read-only.</p>
+<p><code>missingStatement</code> A boolean which denotes if the request failed due to a missing Statement.</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>
+<p><code>missingResults</code> A boolean which denotes if the request failed due to a missing ResultSet.</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>
+<p><code>rpcMetadata</code> <a href="#rpcmetadata">Server metadata</a> about this call.</p>
 
-<h3 id="typedvalue">TypedValue</h3>
+<h3 id="openconnectionresponse">OpenConnectionResponse</h3>
+
+<p>A response to the <a href="#openconnectionrequest">OpenConnectionRequest</a>. The ID for the connection that
+the client should use in subsequent calls was provided by the client in the request.</p>
 
 <div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
-  <span class="nt">&quot;type&quot;</span><span class="p">:</span> <span class="s2">&quot;type_name&quot;</span><span class="p">,</span>
-  <span class="nt">&quot;value&quot;</span><span class="p">:</span> <span class="err">object</span>
+  <span class="nt">&quot;response&quot;</span><span class="p">:</span> <span class="s2">&quot;openConnection&quot;</span><span class="p">,</span>
+  <span class="nt">&quot;rpcMetadata&quot;</span><span class="p">:</span> <span class="err">RpcMetadata</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>rpcMetadata</code> <a href="#rpcmetadata">Server metadata</a> about this call.</p>
 
-<p><code>value</code> A JSON representation of a JDBC type.</p>
+<h3 id="prepareresponse">PrepareResponse</h3>
 
-<h3 id="signature">Signature</h3>
+<p>A response to the <a href="#preparerequest">PrepareRequest</a>. This response includes a <a href="#statementhandle">StatementHandle</a>
+which clients must use to fetch the results from the Statement.</p>
 
 <div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
-  <span class="nt">&quot;columns&quot;</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">&quot;sql&quot;</span><span class="p">:</span> <span class="s2">&quot;SELECT * FROM table&quot;</span><span class="p">,</span>
-  <span class="nt">&quot;parameters&quot;</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">&quot;cursorFactory&quot;</span><span class="p">:</span> <span class="err">CursorFactory</span>
+  <span class="nt">&quot;response&quot;</span><span class="p">:</span> <span class="s2">&quot;prepare&quot;</span><span class="p">,</span>
+  <span class="nt">&quot;statement&quot;</span><span class="p">:</span> <span class="err">StatementHandle</span><span class="p">,</span>
+  <span class="nt">&quot;rpcMetadata&quot;</span><span class="p">:</span> <span class="err">RpcMetadata</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>statement</code> A <a href="#statementhandle">StatementHandle</a> object.</p>
 
-<p><code>sql</code> The SQL executed.</p>
+<p><code>rpcMetadata</code> <a href="#rpcmetadata">Server metadata</a> about this call.</p>
 
-<p><code>parameters</code> An array of <a href="#avaticaparameter">AvaticaParameter</a> objects denoting type-specific details.</p>
+<h3 id="resultsetresponse">ResultSetResponse</h3>
 
-<p><code>cursorFactory</code> An <a href="#cursorfactory">CursorFactory</a> object representing the Java representation of the frame.</p>
+<p>A response which contains the results and type details from a query.</p>
 
-<h3 id="frame">Frame</h3>
+<div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
+  <span class="nt">&quot;response&quot;</span><span class="p">:</span> <span class="s2">&quot;resultSet&quot;</span><span class="p">,</span>
+  <span class="nt">&quot;connectionId&quot;</span><span class="p">:</span> <span class="s2">&quot;000000-0000-0000-00000000&quot;</span><span class="p">,</span>
+  <span class="nt">&quot;statementId&quot;</span><span class="p">:</span> <span class="mi">12345</span><span class="p">,</span>
+  <span class="nt">&quot;ownStatement&quot;</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
+  <span class="nt">&quot;signature&quot;</span><span class="p">:</span> <span class="err">Signature</span><span class="p">,</span>
+  <span class="nt">&quot;firstFrame&quot;</span><span class="p">:</span> <span class="err">Frame</span><span class="p">,</span>
+  <span class="nt">&quot;updateCount&quot;</span><span class="p">:</span> <span class="mi">10</span><span class="p">,</span>
+  <span class="nt">&quot;rpcMetadata&quot;</span><span class="p">:</span> <span class="err">RpcMetadata</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>
+
+<p><code>rpcMetadata</code> <a href="#rpcmetadata">Server metadata</a> about this call.</p>
+
+<h3 id="rollbackresponse">RollbackResponse</h3>
+
+<p>A response to the <a href="#rollbackrequest">RollBackRequest</a>.</p>
 
 <div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
-  <span class="nt">&quot;offset&quot;</span><span class="p">:</span> <span class="mi">100</span><span class="p">,</span>
-  <span class="nt">&quot;done&quot;</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
-  <span class="nt">&quot;rows&quot;</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="nt">&quot;response&quot;</span><span class="p">:</span> <span class="s2">&quot;rollback&quot;</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>There are no extra attributes on this Response.</p>
 
-<p><code>done</code> A boolean denoting whether more results exist for this result set.</p>
+<h3 id="syncresultsresponse">SyncResultsResponse</h3>
 
-<p><code>rows</code> An array of arrays corresponding to the rows and columns for the result set.</p>
+<p>A response to the <a href="#syncresultsrequest">SyncResultsRequest</a>. When <code>moreResults</code> is true, a <a href="#fetchrequest">FetchRequest</a>
+should be issued to get the next batch of records. When <code>missingStatement</code> is true, the statement must be re-created using <a href="#preparerequest">PrepareRequest</a>
+or the appropriate Request for a DDL request (e.g. <a href="#catalogsrequest">CatalogsRequest</a> or <a href="#schemasrequest">SchemasRequest</a>).</p>
 
-<h3 id="statementhandle">StatementHandle</h3>
+<div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
+  <span class="nt">&quot;response&quot;</span><span class="p">:</span> <span class="s2">&quot;syncResults&quot;</span><span class="p">,</span>
+  <span class="nt">&quot;moreResults&quot;</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
+  <span class="nt">&quot;missingStatement&quot;</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
+  <span class="nt">&quot;rpcMetadata&quot;</span><span class="p">:</span> <span class="err">RpcMetadata</span>
+<span class="p">}</span></code></pre></div>
+
+<p><code>moreResults</code> A boolean which denotes if results exist for the ResultSet being “synced” per the request.</p>
+
+<p><code>missingStatement</code> A boolean which denotes if the statement for the ResultSet still exists.</p>
+
+<p><code>rpcMetadata</code> <a href="#rpcmetadata">Server metadata</a> about this call.</p>
+
+<h2 id="miscellaneous-1">Miscellaneous</h2>
+
+<h3 id="avaticaparameter">AvaticaParameter</h3>
+
+<p>This object describes the “simple”, or scalar, JDBC type representation of a column in a result. This does not include
+complex types such as arrays.</p>
 
 <div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
-  <span class="nt">&quot;connectionId&quot;</span><span class="p">:</span> <span class="s2">&quot;000000-0000-0000-00000000&quot;</span><span class="p">,</span>
-  <span class="nt">&quot;id&quot;</span><span class="p">:</span> <span class="mi">12345</span><span class="p">,</span>
-  <span class="nt">&quot;signature&quot;</span><span class="p">:</span> <span class="err">Signature</span>
+  <span class="nt">&quot;signed&quot;</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
+  <span class="nt">&quot;precision&quot;</span><span class="p">:</span> <span class="mi">10</span><span class="p">,</span>
+  <span class="nt">&quot;scale&quot;</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span>
+  <span class="nt">&quot;parameterType&quot;</span><span class="p">:</span> <span class="mi">8</span><span class="p">,</span>
+  <span class="nt">&quot;typeName&quot;</span><span class="p">:</span> <span class="s2">&quot;integer&quot;</span><span class="p">,</span>
+  <span class="nt">&quot;className&quot;</span><span class="p">:</span> <span class="s2">&quot;java.lang.Integer&quot;</span><span class="p">,</span>
+  <span class="nt">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;number&quot;</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>signed</code> A boolean denoting whether the column is a signed numeric.</p>
 
-<p><code>id</code> The identifier of the statement.</p>
+<p><code>precision</code> The maximum numeric precision supported by this column.</p>
 
-<p><code>signature</code> A <a href="#signature">Signature</a> object for the statement.</p>
+<p><code>scale</code> The maximum numeric scale supported by this column.</p>
 
-<h3 id="databaseproperty">DatabaseProperty</h3>
+<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="avaticaseverity">AvaticaSeverity</h3>
+
+<p>This enumeration describes the various levels of concern for an error in the Avatica server.</p>
 
 <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>
+  <li><code>UNKNOWN</code></li>
+  <li><code>FATAL</code></li>
+  <li><code>ERROR</code></li>
+  <li><code>WARNING</code></li>
 </ul>
 
+<h3 id="avaticatype">AvaticaType</h3>
+
+<p>This object describes a simple or complex type for a column. Complex types will contain
+additional information in the <code>component</code> or <code>columns</code> attribute which describe the nested
+types of the complex parent type.</p>
+
+<div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
+  <span class="nt">&quot;type&quot;</span><span class="p">:</span> <span class="s2">&quot;scalar&quot;</span><span class="p">,</span>
+  <span class="nt">&quot;id&quot;</span><span class="p">:</span> <span class="s2">&quot;identifier&quot;</span><span class="p">,</span>
+  <span class="nt">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;column&quot;</span><span class="p">,</span>
+  <span class="nt">&quot;rep&quot;</span><span class="p">:</span> <span class="err">Rep</span><span class="p">,</span>
+  <span class="nt">&quot;columns&quot;</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">&quot;component&quot;</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="columnmetadata">ColumnMetaData</h3>
 
+<p>This object represents the JDBC ResultSetMetaData for a column.</p>
+
 <div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
   <span class="nt">&quot;ordinal&quot;</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
   <span class="nt">&quot;autoIncrement&quot;</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
@@ -1121,109 +1403,243 @@ specification. This value is analogous t
 
 <p><code>columnClassName</code> The name of the Java class backing the column’s type.</p>
 
-<h3 id="avaticaparameter">AvaticaParameter</h3>
+<h3 id="connectionproperties">ConnectionProperties</h3>
+
+<p>This object represents the properties for a given JDBC Connection.</p>
 
 <div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
-  <span class="nt">&quot;signed&quot;</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
-  <span class="nt">&quot;precision&quot;</span><span class="p">:</span> <span class="mi">10</span><span class="p">,</span>
-  <span class="nt">&quot;scale&quot;</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span>
-  <span class="nt">&quot;parameterType&quot;</span><span class="p">:</span> <span class="mi">8</span><span class="p">,</span>
-  <span class="nt">&quot;typeName&quot;</span><span class="p">:</span> <span class="s2">&quot;integer&quot;</span><span class="p">,</span>
-  <span class="nt">&quot;className&quot;</span><span class="p">:</span> <span class="s2">&quot;java.lang.Integer&quot;</span><span class="p">,</span>
-  <span class="nt">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;number&quot;</span>
+  <span class="nt">&quot;connProps&quot;</span><span class="p">:</span> <span class="s2">&quot;connPropsImpl&quot;</span><span class="p">,</span>
+  <span class="nt">&quot;autoCommit&quot;</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
+  <span class="nt">&quot;readOnly&quot;</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
+  <span class="nt">&quot;transactionIsolation&quot;</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+  <span class="nt">&quot;catalog&quot;</span><span class="p">:</span> <span class="s2">&quot;catalog&quot;</span><span class="p">,</span>
+  <span class="nt">&quot;schema&quot;</span><span class="p">:</span> <span class="s2">&quot;schema&quot;</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>autoCommit</code> (optional boolean) A boolean denoting if autoCommit is enabled for transactions.</p>
 
-<p><code>precision</code> The maximum numeric precision supported by this column.</p>
+<p><code>readOnly</code> (optional boolean) A boolean denoting if a JDBC connection is read-only.</p>
 
-<p><code>scale</code> The maximum numeric scale supported by this column.</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 defined in <code>java.sql.Connection</code>.</p>
 
-<p><code>parameterType</code> An integer corresponding to the JDBC Types class denoting the column’s type.</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>
 
-<p><code>typeName</code> The JDBC type name for this column.</p>
+<p><code>catalog</code> (optional string) The name of the catalog to include when fetching connection properties.</p>
 
-<p><code>className</code> The Java class backing the JDBC type for this column.</p>
+<p><code>schema</code> (optional string) The name of the schema to include when fetching connection properties.</p>
 
-<p><code>name</code> The name of the column.</p>
+<h3 id="cursorfactory">CursorFactory</h3>
 
-<h3 id="avaticatype">AvaticaType</h3>
+<p>This object represents the information required to cast untyped objects into the necessary type for some results.</p>
 
 <div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
-  <span class="nt">&quot;type&quot;</span><span class="p">:</span> <span class="s2">&quot;scalar&quot;</span><span class="p">,</span>
-  <span class="nt">&quot;id&quot;</span><span class="p">:</span> <span class="s2">&quot;identifier&quot;</span><span class="p">,</span>
-  <span class="nt">&quot;name&quot;</span><span class="p">:</span> <span class="s2">&quot;column&quot;</span><span class="p">,</span>
-  <span class="nt">&quot;rep&quot;</span><span class="p">:</span> <span class="err">Rep</span><span class="p">,</span>
-  <span class="nt">&quot;columns&quot;</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">&quot;component&quot;</span><span class="p">:</span> <span class="err">AvaticaType</span>
+  <span class="nt">&quot;style&quot;</span><span class="p">:</span> <span class="err">Style</span><span class="p">,</span>
+  <span class="nt">&quot;clazz&quot;</span><span class="p">:</span> <span class="s2">&quot;java.lang.String&quot;</span><span class="p">,</span>
+  <span class="nt">&quot;fieldNames&quot;</span><span class="p">:</span> <span class="p">[</span> <span class="s2">&quot;column1&quot;</span><span class="p">,</span> <span class="s2">&quot;column2&quot;</span><span class="p">,</span> <span class="err">...</span> <span class="p">]</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>style</code> A string denoting the <a href="#style">Style</a> of the contained objects.</p>
 
-<p><code>id</code> A numeric value corresponding to the type of the object per the JDBC Types class.</p>
+<h3 id="databaseproperty">DatabaseProperty</h3>
 
-<p><code>name</code> The readable name of the JDBC type.</p>
+<p>This object represents the exposed database properties for a Connection through the Avatica server.</p>
 
-<p><code>rep</code> A nested <a href="#rep">Rep</a> object used by Avatica to hold additional type information.</p>
+<p>One of:</p>
 
-<p><code>columns</code> For <code>STRUCT</code> types, a list of the columns contained in that <code>STRUCT</code>.</p>
+<ul>
+  <li><code>GET_STRING_FUNCTIONS</code></li>
+  <li><code>GET_NUMERIC_FUNCTIONS</code></li>
+  <li><code>GET_SYSTEM_FUNCTIONS</code></li>
+  <li><code>GET_TIME_DATE_FUNCTIONS</code></li>
+  <li><code>GET_S_Q_L_KEYWORDS</code></li>
+  <li><code>GET_DEFAULT_TRANSACTION_ISOLATION</code></li>
+</ul>
 
-<p><code>component</code> For <code>ARRAY</code> types, the type of the elements contained in that <code>ARRAY</code>.</p>
+<h3 id="frame">Frame</h3>
+
+<p>This object represents a batch of results, tracking the offset into the results and whether more results still exist
+to be fetched in the Avatica server.</p>
+
+<div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
+  <span class="nt">&quot;offset&quot;</span><span class="p">:</span> <span class="mi">100</span><span class="p">,</span>
+  <span class="nt">&quot;done&quot;</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
+  <span class="nt">&quot;rows&quot;</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="querystate">QueryState</h3>
+
+<p>This object represents the way a ResultSet was created in the Avatica server. A ResultSet could be created by a user-provided
+SQL or by a DatabaseMetaData operation with arguments on that operation.</p>
+
+<div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
+  <span class="nt">&quot;type&quot;</span><span class="p">:</span> <span class="err">StateType</span><span class="p">,</span>
+  <span class="nt">&quot;sql&quot;</span><span class="p">:</span> <span class="s2">&quot;SELECT * FROM table&quot;</span><span class="p">,</span>
+  <span class="nt">&quot;metaDataOperation&quot;</span><span class="p">:</span> <span class="err">MetaDataOperation</span><span class="p">,</span>
+  <span class="nt">&quot;operationArgs&quot;</span><span class="p">:</span> <span class="p">[</span><span class="s2">&quot;arg0&quot;</span><span class="p">,</span> <span class="s2">&quot;arg1&quot;</span><span class="p">,</span> <span class="err">...</span> <span class="p">]</span>
+<span class="p">}</span></code></pre></div>
+
+<p><code>type</code> A <a href="#statetype">StateType</a> object denoting what type of operation backs the ResultSet for this query.</p>
+
+<p><code>sql</code> The SQL statement which created the ResultSet for this query. Required if the <code>type</code> is <code>SQL</code>.</p>
+
+<p><code>metaDataOperation</code> The DML operation which created the ResultSet for this query. Required if the <code>type</code> is <code>METADATA</code>.</p>
+
+<p><code>operationArgs</code> The arguments to the invoked DML operation. Required if the <code>type</code> is <code>METADATA</code>.</p>
 
 <h3 id="rep">Rep</h3>
 
+<p>This enumeration represents the concrete Java type for some value.</p>
+
 <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>
+  <li><code>PRIMITIVE_BOOLEAN</code></li>
+  <li><code>PRIMITIVE_BYTE</code></li>
+  <li><code>PRIMITIVE_CHAR</code></li>
+  <li><code>PRIMITIVE_SHORT</code></li>
+  <li><code>PRIMITIVE_INT</code></li>
+  <li><code>PRIMITIVE_LONG</code></li>
+  <li><code>PRIMITIVE_FLOAT</code></li>
+  <li><code>PRIMITIVE_DOUBLE</code></li>
+  <li><code>BOOLEAN</code></li>
+  <li><code>BYTE</code></li>
+  <li><code>CHARACTER</code></li>
+  <li><code>SHORT</code></li>
+  <li><code>INTEGER</code></li>
+  <li><code>LONG</code></li>
+  <li><code>FLOAT</code></li>
+  <li><code>DOUBLE</code></li>
+  <li><code>JAVA_SQL_TIME</code></li>
+  <li><code>JAVA_SQL_TIMESTAMP</code></li>
+  <li><code>JAVA_SQL_DATE</code></li>
+  <li><code>JAVA_UTIL_DATE</code></li>
+  <li><code>BYTE_STRING</code></li>
+  <li><code>STRING</code></li>
+  <li><code>NUMBER</code></li>
+  <li><code>OBJECT</code></li>
 </ul>
 
-<h3 id="cursorfactory">CursorFactory</h3>
+<h3 id="rpcmetadata">RpcMetadata</h3>
+
+<p>This object contains assorted per-call/contextual metadata returned by the Avatica server.</p>
 
 <div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
-  <span class="nt">&quot;style&quot;</span><span class="p">:</span> <span class="err">Style</span><span class="p">,</span>
-  <span class="nt">&quot;clazz&quot;</span><span class="p">:</span> <span class="s2">&quot;java.lang.String&quot;</span><span class="p">,</span>
-  <span class="nt">&quot;fieldNames&quot;</span><span class="p">:</span> <span class="p">[</span> <span class="s2">&quot;column1&quot;</span><span class="p">,</span> <span class="s2">&quot;column2&quot;</span><span class="p">,</span> <span class="err">...</span> <span class="p">]</span>
+  <span class="nt">&quot;serverAddress&quot;</span><span class="p">:</span> <span class="s2">&quot;localhost:8765&quot;</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>
+<p><code>serverAddress</code> The <code>host:port</code> of the server which created this object.</p>
+
+<h3 id="signature">Signature</h3>
+
+<p>This object represents the result of preparing a Statement in the Avatica server.</p>
+
+<div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
+  <span class="nt">&quot;columns&quot;</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">&quot;sql&quot;</span><span class="p">:</span> <span class="s2">&quot;SELECT * FROM table&quot;</span><span class="p">,</span>
+  <span class="nt">&quot;parameters&quot;</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">&quot;cursorFactory&quot;</span><span class="p">:</span> <span class="err">CursorFactory</span><span class="p">,</span>
+  <span class="nt">&quot;statementType&quot;</span><span class="p">:</span> <span class="err">StatementType</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>
+
+<p><code>statementType</code> An <a href="#statementtype">StatementType</a> object representing the type of Statement.</p>
+
+<h3 id="statetype">StateType</h3>
+
+<p>This enumeration denotes whether user-provided SQL or a DatabaseMetaData operation was used to create some ResultSet.</p>
+
+<p>One of:</p>
+
+<ul>
+  <li><code>SQL</code></li>
+  <li><code>METADATA</code></li>
+</ul>
+
+<h3 id="statementhandle">StatementHandle</h3>
+
+<p>This object encapsulates all of the information of a Statement created in the Avatica server.</p>
+
+<div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
+  <span class="nt">&quot;connectionId&quot;</span><span class="p">:</span> <span class="s2">&quot;000000-0000-0000-00000000&quot;</span><span class="p">,</span>
+  <span class="nt">&quot;id&quot;</span><span class="p">:</span> <span class="mi">12345</span><span class="p">,</span>
+  <span class="nt">&quot;signature&quot;</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="statementtype">StatementType</h3>
+
+<p>This enumeration represents what kind the Statement is.</p>
+
+<p>One of:</p>
+
+<ul>
+  <li><code>SELECT</code></li>
+  <li><code>INSERT</code></li>
+  <li><code>UPDATE</code></li>
+  <li><code>DELETE</code></li>
+  <li><code>UPSERT</code></li>
+  <li><code>MERGE</code></li>
+  <li><code>OTHER_DML</code></li>
+  <li><code>CREATE</code></li>
+  <li><code>DROP</code></li>
+  <li><code>ALTER</code></li>
+  <li><code>OTHER_DDL</code></li>
+  <li><code>CALL</code></li>
+</ul>
 
 <h3 id="style">Style</h3>
 
+<p>This enumeration represents the generic “class” of type for a value.</p>
+
 <p>One of:</p>
 
 <ul>
-  <li>“OBJECT”</li>
-  <li>“RECORD”</li>
-  <li>“RECORD_PROJECTION”</li>
-  <li>“ARRAY”</li>
-  <li>“LIST”</li>
-  <li>“MAP”</li>
+  <li><code>OBJECT</code></li>
+  <li><code>RECORD</code></li>
+  <li><code>RECORD_PROJECTION</code></li>
+  <li><code>ARRAY</code></li>
+  <li><code>LIST</code></li>
+  <li><code>MAP</code></li>
 </ul>
 
+<h3 id="typedvalue">TypedValue</h3>
+
+<p>This object encapsulates the type and value for a column in a row.</p>
+
+<div class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span>
+  <span class="nt">&quot;type&quot;</span><span class="p">:</span> <span class="s2">&quot;type_name&quot;</span><span class="p">,</span>
+  <span class="nt">&quot;value&quot;</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>
+
           
 
 
@@ -1268,7 +1684,7 @@ specification. This value is analogous t
           
             
             
-            <a href="/docs/reference.html" class="next">Next</a>
+            <a href="/docs/avatica_protobuf_reference.html" class="next">Next</a>
           
       </div>
     </div>
@@ -1348,6 +1764,12 @@ specification. This value is analogous t
       
     
     
+  
+    
+    
+      
+    
+    
       <li class=""><a href="/docs/index.html">Background</a></li>
       
 
@@ -1450,6 +1872,12 @@ specification. This value is analogous t
       
     
     
+  
+    
+    
+      
+    
+    
       <li class=""><a href="/docs/tutorial.html">Tutorial</a></li>
       
 
@@ -1590,6 +2018,12 @@ specification. This value is analogous t
       
     
     
+  
+    
+    
+      
+    
+    
       <li class=""><a href="/docs/stream.html">Streaming</a></li>
       
 
@@ -1662,6 +2096,12 @@ specification. This value is analogous t
       
     
     
+  
+    
+    
+      
+    
+    
       <li class=""><a href="/docs/lattice.html">Lattices</a></li>
       
 
@@ -1760,6 +2200,12 @@ specification. This value is analogous t
       
     
     
+  
+    
+    
+      
+    
+    
       <li class=""><a href="/docs/avatica_roadmap.html">Roadmap</a></li>
       
 
@@ -1800,6 +2246,54 @@ specification. This value is analogous t
       
 
 
+  
+  
+  
+
+  
+    
+  
+
+  
+    
+    
+      
+    
+    
+  
+    
+    
+      
+    
+    
+  
+    
+    
+      
+    
+    
+  
+    
+    
+      
+    
+    
+  
+    
+    
+      
+    
+    
+  
+    
+    
+      
+    
+    
+      <li class=""><a href="/docs/avatica_protobuf_reference.html">Protobuf Reference</a></li>
+      
+
+
 </ul>
 
     
@@ -1888,6 +2382,12 @@ specification. This value is analogous t
       
     
     
+  
+    
+    
+      
+    
+    
       <li class=""><a href="/docs/reference.html">SQL language</a></li>
       
 
@@ -1966,6 +2466,12 @@ specification. This value is analogous t
       
     
     
+  
+    
+    
+      
+    
+    
       <li class=""><a href="/docs/model.html">JSON models</a></li>
       
 
@@ -2026,6 +2532,12 @@ specification. This value is analogous t
       
     
     
+  
+    
+    
+      
+    
+    
       <li class=""><a href="/docs/howto.html">HOWTO</a></li>
       
 
@@ -2088,6 +2600,12 @@ specification. This value is analogous t
       
     
     
+  
+    
+    
+      
+    
+    
       <li class=""><a href="/docs/history.html">History</a></li>
       
 
@@ -2133,6 +2651,12 @@ specification. This value is analogous t
   
     
     
+      
+    
+    
+  
+    
+    
       
     
     

Modified: calcite/site/docs/avatica_overview.html
URL: http://svn.apache.org/viewvc/calcite/site/docs/avatica_overview.html?rev=1721255&r1=1721254&r2=1721255&view=diff
==============================================================================
--- calcite/site/docs/avatica_overview.html (original)
+++ calcite/site/docs/avatica_overview.html Mon Dec 21 20:16:32 2015
@@ -120,6 +120,8 @@
   
     
   
+    
+  
 
   
 
@@ -154,6 +156,8 @@
   
     
   
+    
+  
 
   
 
@@ -188,6 +192,8 @@
   
     
   
+    
+  
 
 
     </optgroup>
@@ -229,6 +235,8 @@
   
     
   
+    
+  
 
   
 
@@ -263,6 +271,8 @@
   
     
   
+    
+  
 
   
 
@@ -297,6 +307,8 @@
   
     
   
+    
+  
 
 
     </optgroup>
@@ -338,6 +350,8 @@
   
     
   
+    
+  
 
   
 
@@ -372,6 +386,8 @@
   
     
   
+    
+  
 
   
 
@@ -406,6 +422,44 @@
   
     
   
+    
+  
+
+  
+
+  
+    
+  
+    
+  
+    
+  
+    
+  
+    
+  
+    
+  
+    
+  
+    
+  
+    
+  
+    
+  
+    
+  
+    
+  
+    
+  
+    
+  
+    
+  
+    
+  
 
 
     </optgroup>
@@ -447,6 +501,8 @@
   
     
   
+    
+  
 
   
 
@@ -481,6 +537,8 @@
   
     
   
+    
+  
 
   
 
@@ -515,6 +573,8 @@
   
     
   
+    
+  
 
 
     </optgroup>
@@ -556,6 +616,8 @@
   
     
   
+    
+  
 
   
 
@@ -590,6 +652,8 @@
   
     
   
+    
+  
 
   
 
@@ -624,6 +688,8 @@
   
     
   
+    
+  
 
 
     </optgroup>
@@ -877,6 +943,12 @@ At some point Avatica could become a sep
       
     
     
+  
+    
+    
+      
+    
+    
       <li class=""><a href="/docs/index.html">Background</a></li>
       
 
@@ -979,6 +1051,12 @@ At some point Avatica could become a sep
       
     
     
+  
+    
+    
+      
+    
+    
       <li class=""><a href="/docs/tutorial.html">Tutorial</a></li>
       
 
@@ -1119,6 +1197,12 @@ At some point Avatica could become a sep
       
     
     
+  
+    
+    
+      
+    
+    
       <li class=""><a href="/docs/stream.html">Streaming</a></li>
       
 
@@ -1191,6 +1275,12 @@ At some point Avatica could become a sep
       
     
     
+  
+    
+    
+      
+    
+    
       <li class=""><a href="/docs/lattice.html">Lattices</a></li>
       
 
@@ -1289,6 +1379,12 @@ At some point Avatica could become a sep
       
     
     
+  
+    
+    
+      
+    
+    
       <li class=""><a href="/docs/avatica_roadmap.html">Roadmap</a></li>
       
 
@@ -1329,6 +1425,54 @@ At some point Avatica could become a sep
       
 
 
+  
+  
+  
+
+  
+    
+  
+
+  
+    
+    
+      
+    
+    
+  
+    
+    
+      
+    
+    
+  
+    
+    
+      
+    
+    
+  
+    
+    
+      
+    
+    
+  
+    
+    
+      
+    
+    
+  
+    
+    
+      
+    
+    
+      <li class=""><a href="/docs/avatica_protobuf_reference.html">Protobuf Reference</a></li>
+      
+
+
 </ul>
 
     
@@ -1417,6 +1561,12 @@ At some point Avatica could become a sep
       
     
     
+  
+    
+    
+      
+    
+    
       <li class=""><a href="/docs/reference.html">SQL language</a></li>
       
 
@@ -1495,6 +1645,12 @@ At some point Avatica could become a sep
       
     
     
+  
+    
+    
+      
+    
+    
       <li class=""><a href="/docs/model.html">JSON models</a></li>
       
 
@@ -1555,6 +1711,12 @@ At some point Avatica could become a sep
       
     
     
+  
+    
+    
+      
+    
+    
       <li class=""><a href="/docs/howto.html">HOWTO</a></li>
       
 
@@ -1617,6 +1779,12 @@ At some point Avatica could become a sep
       
     
     
+  
+    
+    
+      
+    
+    
       <li class=""><a href="/docs/history.html">History</a></li>
       
 
@@ -1662,6 +1830,12 @@ At some point Avatica could become a sep
   
     
     
+      
+    
+    
+  
+    
+    
       
     
     




Mime
View raw message