Modified: calcite/site/docs/avatica_json_reference.html URL: http://svn.apache.org/viewvc/calcite/site/docs/avatica_json_reference.html?rev=1739659&r1=1739658&r2=1739659&view=diff ============================================================================== --- calcite/site/docs/avatica_json_reference.html (original) +++ calcite/site/docs/avatica_json_reference.html Sun Apr 17 21:26:04 2016 @@ -4,7 +4,7 @@ <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"> + <meta name="generator" content="Jekyll v3.0.3"> <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"> @@ -838,329 +838,329 @@ in Java. For support outside of Java, se <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 +<p>The collection of all JSON objects accepted as requests to Avatica. All Requests include a <code class="highlighter-rouge">request</code> attribute which uniquely identifies the concrete Request from all other Requests.</p> <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">"request"</span><span class="p">:</span> <span class="s2">"getCatalogs"</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> +<figure class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span><span class="w"> + </span><span class="nt">"request"</span><span class="p">:</span><span class="w"> </span><span class="s2">"getCatalogs"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"connectionId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"000000-0000-0000-00000000"</span><span class="w"> +</span><span class="p">}</span></code></pre></figure> -<p><code>connectionId</code> (required string) The identifier of the connection to use.</p> +<p><code class="highlighter-rouge">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">"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> +<figure class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span><span class="w"> + </span><span class="nt">"request"</span><span class="p">:</span><span class="w"> </span><span class="s2">"closeConnection"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"connectionId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"000000-0000-0000-00000000"</span><span class="w"> +</span><span class="p">}</span></code></pre></figure> -<p><code>connectionId</code> (required string) The identifier of the connection to close.</p> +<p><code class="highlighter-rouge">connectionId</code> (required string) The identifier of the connection to close.</p> <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">"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> +<figure class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span><span class="w"> + </span><span class="nt">"request"</span><span class="p">:</span><span class="w"> </span><span class="s2">"closeStatement"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"connectionId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"000000-0000-0000-00000000"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"statementId"</span><span class="p">:</span><span class="w"> </span><span class="mi">12345</span><span class="w"> +</span><span class="p">}</span></code></pre></figure> -<p><code>connectionId</code> (required string) The identifier of the connection to which the statement belongs.</p> +<p><code class="highlighter-rouge">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> +<p><code class="highlighter-rouge">statementId</code> (required integer) The identifier of the statement to close.</p> <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">"request"</span><span class="p">:</span> <span class="s2">"getColumns"</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">"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> +<figure class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span><span class="w"> + </span><span class="nt">"request"</span><span class="p">:</span><span class="w"> </span><span class="s2">"getColumns"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"connectionId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"000000-0000-0000-00000000"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"catalog"</span><span class="p">:</span><span class="w"> </span><span class="s2">"catalog"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"schemaPattern"</span><span class="p">:</span><span class="w"> </span><span class="s2">"schema_pattern.*"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"tableNamePattern"</span><span class="p">:</span><span class="w"> </span><span class="s2">"table_pattern.*"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"columnNamePattern"</span><span class="p">:</span><span class="w"> </span><span class="s2">"column_pattern.*"</span><span class="w"> +</span><span class="p">}</span></code></pre></figure> -<p><code>connectionId</code> (required string) The identifier of the connection on which to fetch the columns.</p> +<p><code class="highlighter-rouge">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 class="highlighter-rouge">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 class="highlighter-rouge">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 class="highlighter-rouge">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> +<p><code class="highlighter-rouge">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> +<p>This request is used to issue a <code class="highlighter-rouge">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">"request"</span><span class="p">:</span> <span class="s2">"commit"</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> +<figure class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span><span class="w"> + </span><span class="nt">"request"</span><span class="p">:</span><span class="w"> </span><span class="s2">"commit"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"connectionId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"000000-0000-0000-00000000"</span><span class="w"> +</span><span class="p">}</span></code></pre></figure> -<p><code>connectionId</code> (required string) The identifier of the connection on which to invoke commit.</p> +<p><code class="highlighter-rouge">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">"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> +<figure class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span><span class="w"> + </span><span class="nt">"request"</span><span class="p">:</span><span class="w"> </span><span class="s2">"connectionSync"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"connectionId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"000000-0000-0000-00000000"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"connProps"</span><span class="p">:</span><span class="w"> </span><span class="err">ConnectionProperties</span><span class="w"> +</span><span class="p">}</span></code></pre></figure> -<p><code>connectionId</code> (required string) The identifier of the connection to synchronize.</p> +<p><code class="highlighter-rouge">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> +<p><code class="highlighter-rouge">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> <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">"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> +<figure class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span><span class="w"> + </span><span class="nt">"request"</span><span class="p">:</span><span class="w"> </span><span class="s2">"createStatement"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"connectionId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"000000-0000-0000-00000000"</span><span class="w"> +</span><span class="p">}</span></code></pre></figure> -<p><code>connectionId</code> (required string) The identifier of the connection to use in creating a statement.</p> +<p><code class="highlighter-rouge">connectionId</code> (required string) The identifier of the connection to use in creating a statement.</p> <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">"request"</span><span class="p">:</span> <span class="s2">"databaseProperties"</span><span class="p">,</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span><span class="w"> + </span><span class="nt">"request"</span><span class="p">:</span><span class="w"> </span><span class="s2">"databaseProperties"</span><span class="p">,</span><span class="w"> +</span><span class="err">}</span></code></pre></figure> -<p><code>connectionId</code> (required string) The identifier of the connection to use when fetching the database properties.</p> +<p><code class="highlighter-rouge">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">"request"</span><span class="p">:</span> <span class="s2">"execute"</span><span class="p">,</span> - <span class="nt">"statementHandle"</span><span class="p">:</span> <span class="err">StatementHandle</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="nt">"maxRowCount"</span><span class="p">:</span> <span class="mi">100</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span><span class="w"> + </span><span class="nt">"request"</span><span class="p">:</span><span class="w"> </span><span class="s2">"execute"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"statementHandle"</span><span class="p">:</span><span class="w"> </span><span class="err">StatementHandle</span><span class="p">,</span><span class="w"> + </span><span class="nt">"parameterValues"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="err">TypedValue</span><span class="p">,</span><span class="w"> </span><span class="err">TypedValue</span><span class="p">,</span><span class="w"> </span><span class="err">...</span><span class="w"> </span><span class="p">],</span><span class="w"> + </span><span class="nt">"maxRowCount"</span><span class="p">:</span><span class="w"> </span><span class="mi">100</span><span class="w"> +</span><span class="p">}</span></code></pre></figure> -<p><code>statementHandle</code> (required object) A <a href="#statementhandle">StatementHandle</a> object.</p> +<p><code class="highlighter-rouge">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 class="highlighter-rouge">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> +<p><code class="highlighter-rouge">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">"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></code></pre></div> +<figure class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span><span class="w"> + </span><span class="nt">"request"</span><span class="p">:</span><span class="w"> </span><span class="s2">"fetch"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"connectionId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"000000-0000-0000-00000000"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"statementId"</span><span class="p">:</span><span class="w"> </span><span class="mi">12345</span><span class="p">,</span><span class="w"> + </span><span class="nt">"offset"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w"> + </span><span class="nt">"fetchMaxRowCount"</span><span class="p">:</span><span class="w"> </span><span class="mi">100</span><span class="w"> +</span><span class="p">}</span></code></pre></figure> -<p><code>connectionId</code> (required string) The identifier of the connection to use.</p> +<p><code class="highlighter-rouge">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 class="highlighter-rouge">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 class="highlighter-rouge">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 class="highlighter-rouge">fetchMatchRowCount</code> (required integer) The maximum number of rows to return in the response to this request.</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">"request"</span><span class="p">:</span> <span class="s2">"openConnection"</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">"info"</span><span class="p">:</span> <span class="p">{</span><span class="nt">"key"</span><span class="p">:</span><span class="s2">"value"</span><span class="p">,</span> <span class="err">...</span><span class="p">}</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span><span class="w"> + </span><span class="nt">"request"</span><span class="p">:</span><span class="w"> </span><span class="s2">"openConnection"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"connectionId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"000000-0000-0000-00000000"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"info"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="nt">"key"</span><span class="p">:</span><span class="s2">"value"</span><span class="p">,</span><span class="w"> </span><span class="err">...}</span><span class="w"> +</span><span class="p">}</span></code></pre></figure> -<p><code>connectionId</code> (required string) The identifier of the connection to open in the server.</p> +<p><code class="highlighter-rouge">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> +<p><code class="highlighter-rouge">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">"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> +<figure class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span><span class="w"> + </span><span class="nt">"request"</span><span class="p">:</span><span class="w"> </span><span class="s2">"prepareAndExecute"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"connectionId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"000000-0000-0000-00000000"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"statementId"</span><span class="p">:</span><span class="w"> </span><span class="mi">12345</span><span class="p">,</span><span class="w"> + </span><span class="nt">"sql"</span><span class="p">:</span><span class="w"> </span><span class="s2">"SELECT * FROM table"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"maxRowCount"</span><span class="p">:</span><span class="w"> </span><span class="mi">100</span><span class="p">,</span><span class="w"> +</span><span class="err">}</span></code></pre></figure> -<p><code>connectionId</code> (required string) The identifier for the connection to use.</p> +<p><code class="highlighter-rouge">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 class="highlighter-rouge">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 class="highlighter-rouge">sql</code> (required string) A SQL statement</p> -<p><code>maxRowCount</code> (required long) The maximum number of rows returned in the response.</p> +<p><code class="highlighter-rouge">maxRowCount</code> (required long) The maximum number of rows returned in the response.</p> <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">"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> +<figure class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span><span class="w"> + </span><span class="nt">"request"</span><span class="p">:</span><span class="w"> </span><span class="s2">"prepare"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"connectionId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"000000-0000-0000-00000000"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"sql"</span><span class="p">:</span><span class="w"> </span><span class="s2">"SELECT * FROM table"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"maxRowCount"</span><span class="p">:</span><span class="w"> </span><span class="mi">100</span><span class="p">,</span><span class="w"> +</span><span class="err">}</span></code></pre></figure> -<p><code>connectionId</code> (required string) The identifier for the connection to use.</p> +<p><code class="highlighter-rouge">connectionId</code> (required string) The identifier for the connection to use.</p> -<p><code>sql</code> (required string) A SQL statement</p> +<p><code class="highlighter-rouge">sql</code> (required string) A SQL statement</p> -<p><code>maxRowCount</code> (required long) The maximum number of rows returned in the response.</p> +<p><code class="highlighter-rouge">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">"request"</span><span class="p">:</span> <span class="s2">"syncResults"</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">"state"</span><span class="p">:</span> <span class="err">QueryState</span><span class="p">,</span> - <span class="nt">"offset"</span><span class="p">:</span> <span class="mi">200</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span><span class="w"> + </span><span class="nt">"request"</span><span class="p">:</span><span class="w"> </span><span class="s2">"syncResults"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"connectionId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"000000-0000-0000-00000000"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"statementId"</span><span class="p">:</span><span class="w"> </span><span class="mi">12345</span><span class="p">,</span><span class="w"> + </span><span class="nt">"state"</span><span class="p">:</span><span class="w"> </span><span class="err">QueryState</span><span class="p">,</span><span class="w"> + </span><span class="nt">"offset"</span><span class="p">:</span><span class="w"> </span><span class="mi">200</span><span class="w"> +</span><span class="p">}</span></code></pre></figure> -<p><code>connectionId</code> (required string) The identifier for the connection to use.</p> +<p><code class="highlighter-rouge">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 class="highlighter-rouge">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 class="highlighter-rouge">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> +<p><code class="highlighter-rouge">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> +<p>This request is used to issue a <code class="highlighter-rouge">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">"request"</span><span class="p">:</span> <span class="s2">"rollback"</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> +<figure class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span><span class="w"> + </span><span class="nt">"request"</span><span class="p">:</span><span class="w"> </span><span class="s2">"rollback"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"connectionId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"000000-0000-0000-00000000"</span><span class="w"> +</span><span class="p">}</span></code></pre></figure> -<p><code>connectionId</code> (required string) The identifier for the connection on which to invoke rollback.</p> +<p><code class="highlighter-rouge">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">"request"</span><span class="p">:</span> <span class="s2">"getSchemas"</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">"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> +<figure class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span><span class="w"> + </span><span class="nt">"request"</span><span class="p">:</span><span class="w"> </span><span class="s2">"getSchemas"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"connectionId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"000000-0000-0000-00000000"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"catalog"</span><span class="p">:</span><span class="w"> </span><span class="s2">"name"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"schemaPattern"</span><span class="p">:</span><span class="w"> </span><span class="s2">"pattern.*"</span><span class="w"> +</span><span class="p">}</span></code></pre></figure> -<p><code>connection_id</code> The identifier for the connection to fetch schemas from.</p> +<p><code class="highlighter-rouge">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 class="highlighter-rouge">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> +<p><code class="highlighter-rouge">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">"request"</span><span class="p">:</span> <span class="s2">"getTableTypes"</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> +<figure class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span><span class="w"> + </span><span class="nt">"request"</span><span class="p">:</span><span class="w"> </span><span class="s2">"getTableTypes"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"connectionId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"000000-0000-0000-00000000"</span><span class="w"> +</span><span class="p">}</span></code></pre></figure> -<p><code>connectionId</code> The identifier of the connection to fetch the table types from.</p> +<p><code class="highlighter-rouge">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">"request"</span><span class="p">:</span> <span class="s2">"getTables"</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">"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> +<figure class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span><span class="w"> + </span><span class="nt">"request"</span><span class="p">:</span><span class="w"> </span><span class="s2">"getTables"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"connectionId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"000000-0000-0000-00000000"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"catalog"</span><span class="p">:</span><span class="w"> </span><span class="s2">"catalog_name"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"schemaPattern"</span><span class="p">:</span><span class="w"> </span><span class="s2">"schema_pattern.*"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"tableNamePattern"</span><span class="p">:</span><span class="w"> </span><span class="s2">"table_name_pattern.*"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"typeList"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w"> </span><span class="s2">"TABLE"</span><span class="p">,</span><span class="w"> </span><span class="s2">"VIEW"</span><span class="p">,</span><span class="w"> </span><span class="err">...</span><span class="w"> </span><span class="p">]</span><span class="w"> +</span><span class="p">}</span></code></pre></figure> -<p><code>catalog</code> (optional string) The name of a catalog to restrict fetched tables.</p> +<p><code class="highlighter-rouge">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 class="highlighter-rouge">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 class="highlighter-rouge">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 class="highlighter-rouge">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> +<p><code class="highlighter-rouge">typeList</code> (optional array of string) A list of table types used to restrict fetched tables.</p> <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">"request"</span><span class="p">:</span> <span class="s2">"getTypeInfo"</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> +<figure class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span><span class="w"> + </span><span class="nt">"request"</span><span class="p">:</span><span class="w"> </span><span class="s2">"getTypeInfo"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"connectionId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"000000-0000-0000-00000000"</span><span class="w"> +</span><span class="p">}</span></code></pre></figure> -<p><code>connectionId</code> The identifier of the connection to fetch the types from.</p> +<p><code class="highlighter-rouge">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 +<p>The collection of all JSON objects returned as responses from Avatica. All Responses include a <code class="highlighter-rouge">response</code> attribute which uniquely identifies the concrete Response from all other Responses.</p> <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">"response"</span><span class="p">:</span> <span class="s2">"closeConnection"</span><span class="p">,</span> - <span class="nt">"rpcMetadata"</span><span class="p">:</span> <span class="err">RpcMetadata</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span><span class="w"> + </span><span class="nt">"response"</span><span class="p">:</span><span class="w"> </span><span class="s2">"closeConnection"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"rpcMetadata"</span><span class="p">:</span><span class="w"> </span><span class="err">RpcMetadata</span><span class="w"> +</span><span class="p">}</span></code></pre></figure> -<p><code>rpcMetadata</code> <a href="#rpcmetadata">Server metadata</a> about this call.</p> +<p><code class="highlighter-rouge">rpcMetadata</code> <a href="#rpcmetadata">Server metadata</a> about this call.</p> <h3 id="closestatementresponse">CloseStatementResponse</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">"response"</span><span class="p">:</span> <span class="s2">"closeStatement"</span><span class="p">,</span> - <span class="nt">"rpcMetadata"</span><span class="p">:</span> <span class="err">RpcMetadata</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span><span class="w"> + </span><span class="nt">"response"</span><span class="p">:</span><span class="w"> </span><span class="s2">"closeStatement"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"rpcMetadata"</span><span class="p">:</span><span class="w"> </span><span class="err">RpcMetadata</span><span class="w"> +</span><span class="p">}</span></code></pre></figure> -<p><code>rpcMetadata</code> <a href="#rpcmetadata">Server metadata</a> about this call.</p> +<p><code class="highlighter-rouge">rpcMetadata</code> <a href="#rpcmetadata">Server metadata</a> about this call.</p> <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">"response"</span><span class="p">:</span> <span class="s2">"commit"</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span><span class="w"> + </span><span class="nt">"response"</span><span class="p">:</span><span class="w"> </span><span class="s2">"commit"</span><span class="w"> +</span><span class="p">}</span></code></pre></figure> <p>There are no extra attributes on this Response.</p> @@ -1169,199 +1169,199 @@ which uniquely identifies the concrete R <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">"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> - <span class="nt">"rpcMetadata"</span><span class="p">:</span> <span class="err">RpcMetadata</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span><span class="w"> + </span><span class="nt">"response"</span><span class="p">:</span><span class="w"> </span><span class="s2">"connectionSync"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"connProps"</span><span class="p">:</span><span class="w"> </span><span class="err">ConnectionProperties</span><span class="p">,</span><span class="w"> + </span><span class="nt">"rpcMetadata"</span><span class="p">:</span><span class="w"> </span><span class="err">RpcMetadata</span><span class="w"> +</span><span class="p">}</span></code></pre></figure> -<p><code>connProps</code> The <a href="#connectionproperties">ConnectionProperties</a> that were synchronized.</p> +<p><code class="highlighter-rouge">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> +<p><code class="highlighter-rouge">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> +that was created is included in the response. Clients will use this <code class="highlighter-rouge">statementId</code> in subsequent calls.</p> -<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> - <span class="nt">"rpcMetadata"</span><span class="p">:</span> <span class="err">RpcMetadata</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span><span class="w"> + </span><span class="nt">"response"</span><span class="p">:</span><span class="w"> </span><span class="s2">"createStatement"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"connectionId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"000000-0000-0000-00000000"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"statementId"</span><span class="p">:</span><span class="w"> </span><span class="mi">12345</span><span class="p">,</span><span class="w"> + </span><span class="nt">"rpcMetadata"</span><span class="p">:</span><span class="w"> </span><span class="err">RpcMetadata</span><span class="w"> +</span><span class="p">}</span></code></pre></figure> -<p><code>connectionId</code> The identifier for the connection used to create the statement.</p> +<p><code class="highlighter-rouge">connectionId</code> The identifier for the connection used to create the statement.</p> -<p><code>statementId</code> The identifier for the created statement.</p> +<p><code class="highlighter-rouge">statementId</code> The identifier for the created statement.</p> -<p><code>rpcMetadata</code> <a href="#rpcmetadata">Server metadata</a> about this call.</p> +<p><code class="highlighter-rouge">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">"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="nt">"rpcMetadata"</span><span class="p">:</span> <span class="err">RpcMetadata</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span><span class="w"> + </span><span class="nt">"response"</span><span class="p">:</span><span class="w"> </span><span class="s2">"databaseProperties"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"map"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="err">DatabaseProperty:</span><span class="w"> </span><span class="err">Object,</span><span class="w"> </span><span class="err">DatabaseProperty:</span><span class="w"> </span><span class="err">Object,</span><span class="w"> </span><span class="err">...</span><span class="w"> </span><span class="p">},</span><span class="w"> + </span><span class="nt">"rpcMetadata"</span><span class="p">:</span><span class="w"> </span><span class="err">RpcMetadata</span><span class="w"> +</span><span class="p">}</span></code></pre></figure> -<p><code>map</code> A map of <a href="#databaseproperty">DatabaseProperty</a> to value of that property. The value may be some +<p><code class="highlighter-rouge">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>rpcMetadata</code> <a href="#rpcmetadata">Server metadata</a> about this call.</p> +<p><code class="highlighter-rouge">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">"response"</span><span class="p">:</span> <span class="s2">"error"</span><span class="p">,</span> - <span class="nt">"exceptions"</span><span class="p">:</span> <span class="p">[</span> <span class="s2">"stacktrace"</span><span class="p">,</span> <span class="s2">"stacktrace"</span><span class="p">,</span> <span class="err">...</span> <span class="p">],</span> - <span class="nt">"errorMessage"</span><span class="p">:</span> <span class="s2">"The error message"</span><span class="p">,</span> - <span class="nt">"errorCode"</span><span class="p">:</span> <span class="mi">42</span><span class="p">,</span> - <span class="nt">"sqlState"</span><span class="p">:</span> <span class="s2">"ABC12"</span><span class="p">,</span> - <span class="nt">"severity"</span><span class="p">:</span> <span class="err">AvaticaSeverity</span><span class="p">,</span> - <span class="nt">"rpcMetadata"</span><span class="p">:</span> <span class="err">RpcMetadata</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span><span class="w"> + </span><span class="nt">"response"</span><span class="p">:</span><span class="w"> </span><span class="s2">"error"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"exceptions"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w"> </span><span class="s2">"stacktrace"</span><span class="p">,</span><span class="w"> </span><span class="s2">"stacktrace"</span><span class="p">,</span><span class="w"> </span><span class="err">...</span><span class="w"> </span><span class="p">],</span><span class="w"> + </span><span class="nt">"errorMessage"</span><span class="p">:</span><span class="w"> </span><span class="s2">"The error message"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"errorCode"</span><span class="p">:</span><span class="w"> </span><span class="mi">42</span><span class="p">,</span><span class="w"> + </span><span class="nt">"sqlState"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ABC12"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"severity"</span><span class="p">:</span><span class="w"> </span><span class="err">AvaticaSeverity</span><span class="p">,</span><span class="w"> + </span><span class="nt">"rpcMetadata"</span><span class="p">:</span><span class="w"> </span><span class="err">RpcMetadata</span><span class="w"> +</span><span class="p">}</span></code></pre></figure> -<p><code>exceptions</code> A list of stringified Java StackTraces.</p> +<p><code class="highlighter-rouge">exceptions</code> A list of stringified Java StackTraces.</p> -<p><code>errorMessage</code> A human-readable error message.</p> +<p><code class="highlighter-rouge">errorMessage</code> A human-readable error message.</p> -<p><code>errorCode</code> A numeric code for this error.</p> +<p><code class="highlighter-rouge">errorCode</code> A numeric code for this error.</p> -<p><code>sqlState</code> A five character alphanumeric code for this error.</p> +<p><code class="highlighter-rouge">sqlState</code> A five character alphanumeric code for this error.</p> -<p><code>severity</code> An <a href="#avaticaseverity">AvaticaSeverity</a> object which denotes how critical the error is.</p> +<p><code class="highlighter-rouge">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> +<p><code class="highlighter-rouge">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">"response"</span><span class="p">:</span> <span class="s2">"executeResults"</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="nt">"missingStatement"</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span> - <span class="nt">"rpcMetadata"</span><span class="p">:</span> <span class="err">RpcMetadata</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span><span class="w"> + </span><span class="nt">"response"</span><span class="p">:</span><span class="w"> </span><span class="s2">"executeResults"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"resultSets"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w"> </span><span class="err">ResultSetResponse</span><span class="p">,</span><span class="w"> </span><span class="err">ResultSetResponse</span><span class="p">,</span><span class="w"> </span><span class="err">...</span><span class="w"> </span><span class="p">],</span><span class="w"> + </span><span class="nt">"missingStatement"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w"> + </span><span class="nt">"rpcMetadata"</span><span class="p">:</span><span class="w"> </span><span class="err">RpcMetadata</span><span class="w"> +</span><span class="p">}</span></code></pre></figure> -<p><code>resultSets</code> An array of <a href="#resultsetresponse">ResultSetResponse</a>s.</p> +<p><code class="highlighter-rouge">resultSets</code> An array of <a href="#resultsetresponse">ResultSetResponse</a>s.</p> -<p><code>missingStatement</code> A boolean which denotes if the request failed due to a missing Statement.</p> +<p><code class="highlighter-rouge">missingStatement</code> A boolean which denotes if the request failed due to a missing Statement.</p> -<p><code>rpcMetadata</code> <a href="#rpcmetadata">Server metadata</a> about this call.</p> +<p><code class="highlighter-rouge">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">"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> - <span class="nt">"missingStatement"</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span> - <span class="nt">"missingResults"</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span> - <span class="nt">"rpcMetadata"</span><span class="p">:</span> <span class="err">RpcMetadata</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span><span class="w"> + </span><span class="nt">"response"</span><span class="p">:</span><span class="w"> </span><span class="s2">"fetch"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"frame"</span><span class="p">:</span><span class="w"> </span><span class="err">Frame</span><span class="p">,</span><span class="w"> + </span><span class="nt">"missingStatement"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w"> + </span><span class="nt">"missingResults"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w"> + </span><span class="nt">"rpcMetadata"</span><span class="p">:</span><span class="w"> </span><span class="err">RpcMetadata</span><span class="w"> +</span><span class="p">}</span></code></pre></figure> -<p><code>frame</code> A <a href="#frame">Frame</a> containing the results of the fetch.</p> +<p><code class="highlighter-rouge">frame</code> A <a href="#frame">Frame</a> containing the results of the fetch.</p> -<p><code>missingStatement</code> A boolean which denotes if the request failed due to a missing Statement.</p> +<p><code class="highlighter-rouge">missingStatement</code> A boolean which denotes if the request failed due to a missing Statement.</p> -<p><code>missingResults</code> A boolean which denotes if the request failed due to a missing ResultSet.</p> +<p><code class="highlighter-rouge">missingResults</code> A boolean which denotes if the request failed due to a missing ResultSet.</p> -<p><code>rpcMetadata</code> <a href="#rpcmetadata">Server metadata</a> about this call.</p> +<p><code class="highlighter-rouge">rpcMetadata</code> <a href="#rpcmetadata">Server metadata</a> about this call.</p> <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">"response"</span><span class="p">:</span> <span class="s2">"openConnection"</span><span class="p">,</span> - <span class="nt">"rpcMetadata"</span><span class="p">:</span> <span class="err">RpcMetadata</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span><span class="w"> + </span><span class="nt">"response"</span><span class="p">:</span><span class="w"> </span><span class="s2">"openConnection"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"rpcMetadata"</span><span class="p">:</span><span class="w"> </span><span class="err">RpcMetadata</span><span class="w"> +</span><span class="p">}</span></code></pre></figure> -<p><code>rpcMetadata</code> <a href="#rpcmetadata">Server metadata</a> about this call.</p> +<p><code class="highlighter-rouge">rpcMetadata</code> <a href="#rpcmetadata">Server metadata</a> about this call.</p> <h3 id="prepareresponse">PrepareResponse</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">"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> - <span class="nt">"rpcMetadata"</span><span class="p">:</span> <span class="err">RpcMetadata</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span><span class="w"> + </span><span class="nt">"response"</span><span class="p">:</span><span class="w"> </span><span class="s2">"prepare"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"statement"</span><span class="p">:</span><span class="w"> </span><span class="err">StatementHandle</span><span class="p">,</span><span class="w"> + </span><span class="nt">"rpcMetadata"</span><span class="p">:</span><span class="w"> </span><span class="err">RpcMetadata</span><span class="w"> +</span><span class="p">}</span></code></pre></figure> -<p><code>statement</code> A <a href="#statementhandle">StatementHandle</a> object.</p> +<p><code class="highlighter-rouge">statement</code> A <a href="#statementhandle">StatementHandle</a> object.</p> -<p><code>rpcMetadata</code> <a href="#rpcmetadata">Server metadata</a> about this call.</p> +<p><code class="highlighter-rouge">rpcMetadata</code> <a href="#rpcmetadata">Server metadata</a> about this call.</p> <h3 id="resultsetresponse">ResultSetResponse</h3> <p>A response which contains the results and type details from a query.</p> -<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> - <span class="nt">"rpcMetadata"</span><span class="p">:</span> <span class="err">RpcMetadata</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span><span class="w"> + </span><span class="nt">"response"</span><span class="p">:</span><span class="w"> </span><span class="s2">"resultSet"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"connectionId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"000000-0000-0000-00000000"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"statementId"</span><span class="p">:</span><span class="w"> </span><span class="mi">12345</span><span class="p">,</span><span class="w"> + </span><span class="nt">"ownStatement"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w"> + </span><span class="nt">"signature"</span><span class="p">:</span><span class="w"> </span><span class="err">Signature</span><span class="p">,</span><span class="w"> + </span><span class="nt">"firstFrame"</span><span class="p">:</span><span class="w"> </span><span class="err">Frame</span><span class="p">,</span><span class="w"> + </span><span class="nt">"updateCount"</span><span class="p">:</span><span class="w"> </span><span class="mi">10</span><span class="p">,</span><span class="w"> + </span><span class="nt">"rpcMetadata"</span><span class="p">:</span><span class="w"> </span><span class="err">RpcMetadata</span><span class="w"> +</span><span class="p">}</span></code></pre></figure> -<p><code>connectionId</code> The identifier for the connection used to generate this response.</p> +<p><code class="highlighter-rouge">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 class="highlighter-rouge">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 +<p><code class="highlighter-rouge">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 class="highlighter-rouge">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 class="highlighter-rouge">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 +<p><code class="highlighter-rouge">updateCount</code> A number which is always <code class="highlighter-rouge">-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> +<p><code class="highlighter-rouge">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">"response"</span><span class="p">:</span> <span class="s2">"rollback"</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span><span class="w"> + </span><span class="nt">"response"</span><span class="p">:</span><span class="w"> </span><span class="s2">"rollback"</span><span class="w"> +</span><span class="p">}</span></code></pre></figure> <p>There are no extra attributes on this Response.</p> <h3 id="syncresultsresponse">SyncResultsResponse</h3> -<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> +<p>A response to the <a href="#syncresultsrequest">SyncResultsRequest</a>. When <code class="highlighter-rouge">moreResults</code> is true, a <a href="#fetchrequest">FetchRequest</a> +should be issued to get the next batch of records. When <code class="highlighter-rouge">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> -<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">"syncResults"</span><span class="p">,</span> - <span class="nt">"moreResults"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span> - <span class="nt">"missingStatement"</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span> - <span class="nt">"rpcMetadata"</span><span class="p">:</span> <span class="err">RpcMetadata</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span><span class="w"> + </span><span class="nt">"response"</span><span class="p">:</span><span class="w"> </span><span class="s2">"syncResults"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"moreResults"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w"> + </span><span class="nt">"missingStatement"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w"> + </span><span class="nt">"rpcMetadata"</span><span class="p">:</span><span class="w"> </span><span class="err">RpcMetadata</span><span class="w"> +</span><span class="p">}</span></code></pre></figure> -<p><code>moreResults</code> A boolean which denotes if results exist for the ResultSet being âsyncedâ per the request.</p> +<p><code class="highlighter-rouge">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 class="highlighter-rouge">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> +<p><code class="highlighter-rouge">rpcMetadata</code> <a href="#rpcmetadata">Server metadata</a> about this call.</p> <h2 id="miscellaneous-1">Miscellaneous</h2> @@ -1370,29 +1370,29 @@ or the appropriate Request for a DDL req <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">"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> +<figure class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span><span class="w"> + </span><span class="nt">"signed"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w"> + </span><span class="nt">"precision"</span><span class="p">:</span><span class="w"> </span><span class="mi">10</span><span class="p">,</span><span class="w"> + </span><span class="nt">"scale"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w"> + </span><span class="nt">"parameterType"</span><span class="p">:</span><span class="w"> </span><span class="mi">8</span><span class="p">,</span><span class="w"> + </span><span class="nt">"typeName"</span><span class="p">:</span><span class="w"> </span><span class="s2">"integer"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"className"</span><span class="p">:</span><span class="w"> </span><span class="s2">"java.lang.Integer"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"number"</span><span class="w"> +</span><span class="p">}</span></code></pre></figure> -<p><code>signed</code> A boolean denoting whether the column is a signed numeric.</p> +<p><code class="highlighter-rouge">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 class="highlighter-rouge">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 class="highlighter-rouge">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 class="highlighter-rouge">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 class="highlighter-rouge">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 class="highlighter-rouge">className</code> The Java class backing the JDBC type for this column.</p> -<p><code>name</code> The name of the column.</p> +<p><code class="highlighter-rouge">name</code> The name of the column.</p> <h3 id="avaticaseverity">AvaticaSeverity</h3> @@ -1401,77 +1401,77 @@ complex types such as arrays.</p> <p>One of:</p> <ul> - <li><code>UNKNOWN</code></li> - <li><code>FATAL</code></li> - <li><code>ERROR</code></li> - <li><code>WARNING</code></li> + <li><code class="highlighter-rouge">UNKNOWN</code></li> + <li><code class="highlighter-rouge">FATAL</code></li> + <li><code class="highlighter-rouge">ERROR</code></li> + <li><code class="highlighter-rouge">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 +additional information in the <code class="highlighter-rouge">component</code> or <code class="highlighter-rouge">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">"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> +<figure class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span><span class="w"> + </span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"scalar"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"identifier"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"column"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"rep"</span><span class="p">:</span><span class="w"> </span><span class="err">Rep</span><span class="p">,</span><span class="w"> + </span><span class="nt">"columns"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w"> </span><span class="err">ColumnMetaData</span><span class="p">,</span><span class="w"> </span><span class="err">ColumnMetaData</span><span class="p">,</span><span class="w"> </span><span class="err">...</span><span class="w"> </span><span class="p">],</span><span class="w"> + </span><span class="nt">"component"</span><span class="p">:</span><span class="w"> </span><span class="err">AvaticaType</span><span class="w"> +</span><span class="p">}</span></code></pre></figure> -<p><code>type</code> One of: <code>scalar</code>, <code>array</code>, <code>struct</code>.</p> +<p><code class="highlighter-rouge">type</code> One of: <code class="highlighter-rouge">scalar</code>, <code class="highlighter-rouge">array</code>, <code class="highlighter-rouge">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 class="highlighter-rouge">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 class="highlighter-rouge">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 class="highlighter-rouge">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 class="highlighter-rouge">columns</code> For <code class="highlighter-rouge">STRUCT</code> types, a list of the columns contained in that <code class="highlighter-rouge">STRUCT</code>.</p> -<p><code>component</code> For <code>ARRAY</code> types, the type of the elements contained in that <code>ARRAY</code>.</p> +<p><code class="highlighter-rouge">component</code> For <code class="highlighter-rouge">ARRAY</code> types, the type of the elements contained in that <code class="highlighter-rouge">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">"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> +<figure class="highlight"><pre><code class="language-json" data-lang="json"><span class="p">{</span><span class="w"> + </span><span class="nt">"ordinal"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w"> + </span><span class="nt">"autoIncrement"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w"> + </span><span class="nt">"caseSensitive"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w"> + </span><span class="nt">"searchable"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w"> + </span><span class="nt">"currency"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w"> + </span><span class="nt">"nullable"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w"> + </span><span class="nt">"signed"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w"> + </span><span class="nt">"displaySize"</span><span class="p">:</span><span class="w"> </span><span class="mi">20</span><span class="p">,</span><span class="w"> + </span><span class="nt">"label"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Description"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"columnName"</span><span class="p">:</span><span class="w"> </span><span class="s2">"col1"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"schemaName"</span><span class="p">:</span><span class="w"> </span><span class="s2">"schema"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"precision"</span><span class="p">:</span><span class="w"> </span><span class="mi">10</span><span class="p">,</span><span class="w"> + </span><span class="nt">"scale"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w"> + </span><span class="nt">"tableName"</span><span class="p">:</span><span class="w"> </span><span class="s2">"table"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"catalogName"</span><span class="p">:</span><span class="w"> </span><span class="s2">"catalog"</span><span class="p">,</span><span class="w"> + </span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="err">AvaticaType</span><span class="p">,</span><span class="w"> + </span><span class="nt">"readOnly"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w"> + </span><span class="nt">"writable"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w"> + </span><span class="nt">"definitelyWritable"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w"> + </span><span class="nt">"columnClassName"</span><span class="p">:</span><span class="w"> </span><span class="s2">"java.lang.String"</span><span class="w"> +</span><span class="p">}</span></code></pre></figure> + +<p><code class="highlighter-rouge">ordinal</code> A positional offset number.</p> +
[... 1606 lines stripped ...]
