Modified: calcite/site/avatica/docs/protobuf_reference.html URL: http://svn.apache.org/viewvc/calcite/site/avatica/docs/protobuf_reference.html?rev=1739659&r1=1739658&r2=1739659&view=diff ============================================================================== --- calcite/site/avatica/docs/protobuf_reference.html (original) +++ calcite/site/avatica/docs/protobuf_reference.html Sun Apr 17 21:26:04 2016 @@ -4,7 +4,7 @@ <meta charset="UTF-8"> <title>Protocol Buffers 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="/avatica/css/screen.css"> <link rel="icon" type="image/x-icon" href="/avatica/favicon.ico"> @@ -363,14 +363,14 @@ and inability to differentiate between t absence of a value for a field.</p> <p>Other notable structural differences to JSON include the addition of a -<code>WireMessage</code> message which is used to identify the type of the wrapped message -returned by the server (synonymous with <code>request</code> or <code>response</code> attribute on the -JSON messages) and a change to <code>TypedValue</code> containing an <code>Object</code> value to +<code class="highlighter-rouge">WireMessage</code> message which is used to identify the type of the wrapped message +returned by the server (synonymous with <code class="highlighter-rouge">request</code> or <code class="highlighter-rouge">response</code> attribute on the +JSON messages) and a change to <code class="highlighter-rouge">TypedValue</code> containing an <code class="highlighter-rouge">Object</code> value to a collection of optional strongly-typed values (as protobuf does not natively -support an <code>Object</code> type that is unwrapped at runtime).</p> +support an <code class="highlighter-rouge">Object</code> type that is unwrapped at runtime).</p> -<p>Unless otherwise specified with use of the <code>required</code> modifier, all fields in -all protocol buffer messages are <code>optional</code> by default.</p> +<p>Unless otherwise specified with use of the <code class="highlighter-rouge">required</code> modifier, all fields in +all protocol buffer messages are <code class="highlighter-rouge">optional</code> by default.</p> <h2 id="index">Index</h2> @@ -392,346 +392,346 @@ all protocol buffer messages are <code>o <h2 id="requests-1">Requests</h2> <p>The collection of all protobuf objects accepted as requests to Avatica. All request -objects should be wrapped in a <code>WireMessage</code> before being sent to Avatica.</p> +objects should be wrapped in a <code class="highlighter-rouge">WireMessage</code> before being sent to Avatica.</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-protobuf" data-lang="protobuf"><span class="kd">message</span> <span class="nc">CatalogsRequest</span> <span class="p">{</span> - <span class="kt">string</span> <span class="na">connection_id</span> <span class="o">=</span> <span class="mi">1</span><span class="p">;</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-protobuf" data-lang="protobuf">message CatalogsRequest { + string connection_id = 1; +}</code></pre></figure> -<p><code>connection_id</code> The identifier for the connection to use.</p> +<p><code class="highlighter-rouge">connection_id</code> The identifier for 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-protobuf" data-lang="protobuf"><span class="kd">message</span> <span class="nc">CloseConnectionRequest</span> <span class="p">{</span> - <span class="kt">string</span> <span class="na">connection_id</span> <span class="o">=</span> <span class="mi">1</span><span class="p">;</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-protobuf" data-lang="protobuf">message CloseConnectionRequest { + string connection_id = 1; +}</code></pre></figure> -<p><code>connection_id</code> The identifier of the connection to close.</p> +<p><code class="highlighter-rouge">connection_id</code> 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-protobuf" data-lang="protobuf"><span class="kd">message</span> <span class="nc">CloseStatementRequest</span> <span class="p">{</span> - <span class="kt">string</span> <span class="na">connection_id</span> <span class="o">=</span> <span class="mi">1</span><span class="p">;</span> - <span class="kt">uint32</span> <span class="na">statement_id</span> <span class="o">=</span> <span class="mi">2</span><span class="p">;</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-protobuf" data-lang="protobuf">message CloseStatementRequest { + string connection_id = 1; + uint32 statement_id = 2; +}</code></pre></figure> -<p><code>connection_id</code> The identifier of the connection to which the statement belongs.</p> +<p><code class="highlighter-rouge">connection_id</code> The identifier of the connection to which the statement belongs.</p> -<p><code>statement_id</code> The identifier of the statement to close.</p> +<p><code class="highlighter-rouge">statement_id</code> 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-protobuf" data-lang="protobuf"><span class="kd">message</span> <span class="nc">ColumnsRequest</span> <span class="p">{</span> - <span class="kt">string</span> <span class="na">catalog</span> <span class="o">=</span> <span class="mi">1</span><span class="p">;</span> - <span class="kt">string</span> <span class="na">schema_pattern</span> <span class="o">=</span> <span class="mi">2</span><span class="p">;</span> - <span class="kt">string</span> <span class="na">table_name_pattern</span> <span class="o">=</span> <span class="mi">3</span><span class="p">;</span> - <span class="kt">string</span> <span class="na">column_name_pattern</span> <span class="o">=</span> <span class="mi">4</span><span class="p">;</span> - <span class="kt">string</span> <span class="na">connection_id</span> <span class="o">=</span> <span class="mi">5</span><span class="p">;</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-protobuf" data-lang="protobuf">message ColumnsRequest { + string catalog = 1; + string schema_pattern = 2; + string table_name_pattern = 3; + string column_name_pattern = 4; + string connection_id = 5; +}</code></pre></figure> -<p><code>catalog</code> The name of a catalog to limit returned columns.</p> +<p><code class="highlighter-rouge">catalog</code> The name of a catalog to limit returned columns.</p> -<p><code>schema_pattern</code> A Java Pattern against schemas to limit returned columns.</p> +<p><code class="highlighter-rouge">schema_pattern</code> A Java Pattern against schemas to limit returned columns.</p> -<p><code>table_name_pattern</code> A Java Pattern against table names to limit returned columns.</p> +<p><code class="highlighter-rouge">table_name_pattern</code> A Java Pattern against table names to limit returned columns.</p> -<p><code>column_name_pattern</code> A Java Pattern against column names to limit returned columns.</p> +<p><code class="highlighter-rouge">column_name_pattern</code> A Java Pattern against column names to limit returned columns.</p> -<p><code>connection_id</code> The identifier of the connection which to use to fetch the columns.</p> +<p><code class="highlighter-rouge">connection_id</code> The identifier of the connection which to use to fetch the 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-protobuf" data-lang="protobuf"><span class="kd">message</span> <span class="nc">CommitRequest</span> <span class="p">{</span> - <span class="kt">string</span> <span class="na">connection_id</span> <span class="o">=</span> <span class="mi">1</span><span class="p">;</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-protobuf" data-lang="protobuf">message CommitRequest { + string connection_id = 1; +}</code></pre></figure> -<p><code>connection_id</code> The identifier of the connection on which to invoke commit.</p> +<p><code class="highlighter-rouge">connection_id</code> 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-protobuf" data-lang="protobuf"><span class="kd">message</span> <span class="nc">ConnectionSyncRequest</span> <span class="p">{</span> - <span class="kt">string</span> <span class="na">connection_id</span> <span class="o">=</span> <span class="mi">1</span><span class="p">;</span> - <span class="n">ConnectionProperties</span> <span class="na">conn_props</span> <span class="o">=</span> <span class="mi">2</span><span class="p">;</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-protobuf" data-lang="protobuf">message ConnectionSyncRequest { + string connection_id = 1; + ConnectionProperties conn_props = 2; +}</code></pre></figure> -<p><code>connection_id</code> The identifier of the connection to synchronize.</p> +<p><code class="highlighter-rouge">connection_id</code> The identifier of the connection to synchronize.</p> -<p><code>conn_props</code> A <a href="#connectionproperties">ConnectionProperties</a> object to synchronize between the client and server.</p> +<p><code class="highlighter-rouge">conn_props</code> 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-protobuf" data-lang="protobuf"><span class="kd">message</span> <span class="nc">CreateStatementRequest</span> <span class="p">{</span> - <span class="kt">string</span> <span class="na">connection_id</span> <span class="o">=</span> <span class="mi">1</span><span class="p">;</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-protobuf" data-lang="protobuf">message CreateStatementRequest { + string connection_id = 1; +}</code></pre></figure> -<p><code>connection_id</code> The identifier of the connection to use in creating a statement.</p> +<p><code class="highlighter-rouge">connection_id</code> 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-protobuf" data-lang="protobuf"><span class="kd">message</span> <span class="nc">DatabasePropertyRequest</span> <span class="p">{</span> - <span class="kt">string</span> <span class="na">connection_id</span> <span class="o">=</span> <span class="mi">1</span><span class="p">;</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-protobuf" data-lang="protobuf">message DatabasePropertyRequest { + string connection_id = 1; +}</code></pre></figure> -<p><code>connection_id</code> The identifier of the connection to use when fetching the database properties.</p> +<p><code class="highlighter-rouge">connection_id</code> The identifier of the connection to use when fetching the database properties.</p> <h3 id="executebatchrequest">ExecuteBatchRequest</h3> <p>This request is used to execute a batch of updates against a PreparedStatement.</p> -<div class="highlight"><pre><code class="language-protobuf" data-lang="protobuf"><span class="kd">message</span> <span class="nc">ExecuteBatchRequest</span> <span class="p">{</span> - <span class="kt">string</span> <span class="na">connection_id</span> <span class="o">=</span> <span class="mi">1</span><span class="p">;</span> - <span class="kt">uint32</span> <span class="na">statement_id</span> <span class="o">=</span> <span class="mi">2</span><span class="p">;</span> - <span class="k">repeated</span> <span class="n">UpdateBatch</span> <span class="na">updates</span> <span class="o">=</span> <span class="mi">3</span><span class="p">;</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-protobuf" data-lang="protobuf">message ExecuteBatchRequest { + string connection_id = 1; + uint32 statement_id = 2; + repeated UpdateBatch updates = 3; +}</code></pre></figure> -<p><code>connection_id</code> A string which refers to a connection.</p> +<p><code class="highlighter-rouge">connection_id</code> A string which refers to a connection.</p> -<p><code>statement_id</code> An integer which refers to a statement.</p> +<p><code class="highlighter-rouge">statement_id</code> An integer which refers to a statement.</p> -<p><code>updates</code> A list of <a href="#updatebatch">UpdateBatch</a>âs; the batch of updates.</p> +<p><code class="highlighter-rouge">updates</code> A list of <a href="#updatebatch">UpdateBatch</a>âs; the batch of updates.</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-protobuf" data-lang="protobuf"><span class="kd">message</span> <span class="nc">ExecuteRequest</span> <span class="p">{</span> - <span class="n">StatementHandle</span> <span class="na">statementHandle</span> <span class="o">=</span> <span class="mi">1</span><span class="p">;</span> - <span class="k">repeated</span> <span class="n">TypedValue</span> <span class="na">parameter_values</span> <span class="o">=</span> <span class="mi">2</span><span class="p">;</span> - <span class="kt">uint64</span> <span class="na">max_row_count</span> <span class="o">=</span> <span class="mi">3</span><span class="p">;</span> - <span class="kt">bool</span> <span class="na">has_parameter_values</span> <span class="o">=</span> <span class="mi">4</span><span class="p">;</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-protobuf" data-lang="protobuf">message ExecuteRequest { + StatementHandle statementHandle = 1; + repeated TypedValue parameter_values = 2; + uint64 max_row_count = 3; + bool has_parameter_values = 4; +}</code></pre></figure> -<p><code>statementHandle</code> A <a href="#statementhandle">StatementHandle</a> object.</p> +<p><code class="highlighter-rouge">statementHandle</code> A <a href="#statementhandle">StatementHandle</a> object.</p> -<p><code>parameter_values</code> The <a href="#typedvalue">TypedValue</a> for each parameter on the prepared statement.</p> +<p><code class="highlighter-rouge">parameter_values</code> The <a href="#typedvalue">TypedValue</a> for each parameter on the prepared statement.</p> -<p><code>max_row_count</code> The maximum number of rows returned in the response.</p> +<p><code class="highlighter-rouge">max_row_count</code> The maximum number of rows returned in the response.</p> -<p><code>has_parameter_values</code> A boolean which denotes if the user set a value for the <code>parameter_values</code> field.</p> +<p><code class="highlighter-rouge">has_parameter_values</code> A boolean which denotes if the user set a value for the <code class="highlighter-rouge">parameter_values</code> field.</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-protobuf" data-lang="protobuf"><span class="kd">message</span> <span class="nc">FetchRequest</span> <span class="p">{</span> - <span class="kt">string</span> <span class="na">connection_id</span> <span class="o">=</span> <span class="mi">1</span><span class="p">;</span> - <span class="kt">uint32</span> <span class="na">statement_id</span> <span class="o">=</span> <span class="mi">2</span><span class="p">;</span> - <span class="kt">uint64</span> <span class="na">offset</span> <span class="o">=</span> <span class="mi">3</span><span class="p">;</span> - <span class="kt">uint32</span> <span class="na">fetch_max_row_count</span> <span class="o">=</span> <span class="mi">4</span><span class="p">;</span> <span class="c1">// Maximum number of rows to be returned in the frame. Negative means no limit.</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-protobuf" data-lang="protobuf">message FetchRequest { + string connection_id = 1; + uint32 statement_id = 2; + uint64 offset = 3; + uint32 fetch_max_row_count = 4; // Maximum number of rows to be returned in the frame. Negative means no limit. +}</code></pre></figure> -<p><code>connection_id</code> The identifier of the connection to use.</p> +<p><code class="highlighter-rouge">connection_id</code> The identifier of the connection to use.</p> -<p><code>statement_id</code> The identifier of the statement created using the above connection.</p> +<p><code class="highlighter-rouge">statement_id</code> The identifier of the statement created using the above connection.</p> -<p><code>offset</code> The positional offset into a result set to fetch.</p> +<p><code class="highlighter-rouge">offset</code> The positional offset into a result set to fetch.</p> -<p><code>fetch_match_row_count</code> The maximum number of rows to return in the response to this request.</p> +<p><code class="highlighter-rouge">fetch_match_row_count</code> 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-protobuf" data-lang="protobuf"><span class="kd">message</span> <span class="nc">OpenConnectionRequest</span> <span class="p">{</span> - <span class="kt">string</span> <span class="na">connection_id</span> <span class="o">=</span> <span class="mi">1</span><span class="p">;</span> - <span class="n">map</span><span class="o"><</span><span class="kt">string</span><span class="p">,</span> <span class="kt">string</span><span class="err">></span> <span class="mf">inf</span><span class="na">o</span> <span class="o">=</span> <span class="mi">2</span><span class="p">;</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-protobuf" data-lang="protobuf">message OpenConnectionRequest { + string connection_id = 1; + map<string, string> info = 2; +}</code></pre></figure> -<p><code>connection_id</code> The identifier of the connection to open in the server.</p> +<p><code class="highlighter-rouge">connection_id</code> The identifier of the connection to open in the server.</p> -<p><code>info</code> A Map containing properties to include when creating the Connection.</p> +<p><code class="highlighter-rouge">info</code> A Map containing properties to include when creating the Connection.</p> <h3 id="prepareandexecutebatchrequest">PrepareAndExecuteBatchRequest</h3> <p>This request is used as short-hand to create a Statement and execute a batch of updates against that Statement.</p> -<div class="highlight"><pre><code class="language-protobuf" data-lang="protobuf"><span class="kd">message</span> <span class="nc">PrepareAndExecuteBatchRequest</span> <span class="p">{</span> - <span class="kt">string</span> <span class="na">connection_id</span> <span class="o">=</span> <span class="mi">1</span><span class="p">;</span> - <span class="kt">uint32</span> <span class="na">statement_id</span> <span class="o">=</span> <span class="mi">2</span><span class="p">;</span> - <span class="k">repeated</span> <span class="kt">string</span> <span class="na">sql_commands</span> <span class="o">=</span> <span class="mi">3</span><span class="p">;</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-protobuf" data-lang="protobuf">message PrepareAndExecuteBatchRequest { + string connection_id = 1; + uint32 statement_id = 2; + repeated string sql_commands = 3; +}</code></pre></figure> -<p><code>connection_id</code> The identifier for the connection to use.</p> +<p><code class="highlighter-rouge">connection_id</code> The identifier for the connection to use.</p> -<p><code>statement_id</code> The identifier for the statement created by the above connection to use.</p> +<p><code class="highlighter-rouge">statement_id</code> The identifier for the statement created by the above connection to use.</p> -<p><code>sql_commands</code> A list of SQL commands to execute; a batch.</p> +<p><code class="highlighter-rouge">sql_commands</code> A list of SQL commands to execute; a batch.</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-protobuf" data-lang="protobuf"><span class="kd">message</span> <span class="nc">PrepareAndExecuteRequest</span> <span class="p">{</span> - <span class="kt">string</span> <span class="na">connection_id</span> <span class="o">=</span> <span class="mi">1</span><span class="p">;</span> - <span class="kt">uint32</span> <span class="na">statement_id</span> <span class="o">=</span> <span class="mi">4</span><span class="p">;</span> - <span class="kt">string</span> <span class="na">sql</span> <span class="o">=</span> <span class="mi">2</span><span class="p">;</span> - <span class="kt">uint64</span> <span class="na">max_row_count</span> <span class="o">=</span> <span class="mi">3</span><span class="p">;</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-protobuf" data-lang="protobuf">message PrepareAndExecuteRequest { + string connection_id = 1; + uint32 statement_id = 4; + string sql = 2; + uint64 max_row_count = 3; +}</code></pre></figure> -<p><code>connection_id</code> The identifier for the connection to use.</p> +<p><code class="highlighter-rouge">connection_id</code> The identifier for the connection to use.</p> -<p><code>statement_id</code> The identifier for the statement created by the above connection to use.</p> +<p><code class="highlighter-rouge">statement_id</code> The identifier for the statement created by the above connection to use.</p> -<p><code>sql</code> A SQL statement</p> +<p><code class="highlighter-rouge">sql</code> A SQL statement</p> -<p><code>max_row_count</code> The maximum number of rows returned in the response.</p> +<p><code class="highlighter-rouge">max_row_count</code> 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-protobuf" data-lang="protobuf"><span class="kd">message</span> <span class="nc">PrepareRequest</span> <span class="p">{</span> - <span class="kt">string</span> <span class="na">connection_id</span> <span class="o">=</span> <span class="mi">1</span><span class="p">;</span> - <span class="kt">string</span> <span class="na">sql</span> <span class="o">=</span> <span class="mi">2</span><span class="p">;</span> - <span class="kt">uint64</span> <span class="na">max_row_count</span> <span class="o">=</span> <span class="mi">3</span><span class="p">;</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-protobuf" data-lang="protobuf">message PrepareRequest { + string connection_id = 1; + string sql = 2; + uint64 max_row_count = 3; +}</code></pre></figure> -<p><code>connection_id</code> The identifier for the connection to use.</p> +<p><code class="highlighter-rouge">connection_id</code> The identifier for the connection to use.</p> -<p><code>sql</code> A SQL statement</p> +<p><code class="highlighter-rouge">sql</code> A SQL statement</p> -<p><code>max_row_count</code> The maximum number of rows returned in the response.</p> +<p><code class="highlighter-rouge">max_row_count</code> 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-protobuf" data-lang="protobuf"><span class="kd">message</span> <span class="nc">SyncResultsRequest</span> <span class="p">{</span> - <span class="kt">string</span> <span class="na">connection_id</span> <span class="o">=</span> <span class="mi">1</span><span class="p">;</span> - <span class="kt">uint32</span> <span class="na">statement_id</span> <span class="o">=</span> <span class="mi">2</span><span class="p">;</span> - <span class="n">QueryState</span> <span class="na">state</span> <span class="o">=</span> <span class="mi">3</span><span class="p">;</span> - <span class="kt">uint64</span> <span class="na">offset</span> <span class="o">=</span> <span class="mi">4</span><span class="p">;</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-protobuf" data-lang="protobuf">message SyncResultsRequest { + string connection_id = 1; + uint32 statement_id = 2; + QueryState state = 3; + uint64 offset = 4; +}</code></pre></figure> -<p><code>connection_id</code> The identifier for the connection to use.</p> +<p><code class="highlighter-rouge">connection_id</code> The identifier for the connection to use.</p> -<p><code>statement_id</code> The identifier for the statement to use.</p> +<p><code class="highlighter-rouge">statement_id</code> The identifier for the statement to use.</p> -<p><code>state</code> The <a href="#querystate">QueryState</a> object.</p> +<p><code class="highlighter-rouge">state</code> The <a href="#querystate">QueryState</a> object.</p> -<p><code>offset</code> The offset into the ResultSet to seek to.</p> +<p><code class="highlighter-rouge">offset</code> 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-protobuf" data-lang="protobuf"><span class="kd">message</span> <span class="nc">RollbackRequest</span> <span class="p">{</span> - <span class="kt">string</span> <span class="na">connection_id</span> <span class="o">=</span> <span class="mi">1</span><span class="p">;</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-protobuf" data-lang="protobuf">message RollbackRequest { + string connection_id = 1; +}</code></pre></figure> -<p><code>connection_id</code> The identifier for the connection on which to invoke rollback.</p> +<p><code class="highlighter-rouge">connection_id</code> 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-protobuf" data-lang="protobuf"><span class="kd">message</span> <span class="nc">SchemasRequest</span> <span class="p">{</span> - <span class="kt">string</span> <span class="na">catalog</span> <span class="o">=</span> <span class="mi">1</span><span class="p">;</span> - <span class="kt">string</span> <span class="na">schema_pattern</span> <span class="o">=</span> <span class="mi">2</span><span class="p">;</span> - <span class="kt">string</span> <span class="na">connection_id</span> <span class="o">=</span> <span class="mi">3</span><span class="p">;</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-protobuf" data-lang="protobuf">message SchemasRequest { + string catalog = 1; + string schema_pattern = 2; + string connection_id = 3; +}</code></pre></figure> -<p><code>catalog</code> The name of the catalog to fetch the schema from.</p> +<p><code class="highlighter-rouge">catalog</code> The name of the catalog to fetch the schema from.</p> -<p><code>schema_pattern</code> A Java pattern of schemas to fetch.</p> +<p><code class="highlighter-rouge">schema_pattern</code> A Java pattern of schemas to fetch.</p> -<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> <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-protobuf" data-lang="protobuf"><span class="kd">message</span> <span class="nc">TableTypesRequest</span> <span class="p">{</span> - <span class="kt">string</span> <span class="na">connection_id</span> <span class="o">=</span> <span class="mi">1</span><span class="p">;</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-protobuf" data-lang="protobuf">message TableTypesRequest { + string connection_id = 1; +}</code></pre></figure> -<p><code>connection_id</code> The identifier of the connection to fetch the table types from.</p> +<p><code class="highlighter-rouge">connection_id</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-protobuf" data-lang="protobuf"><span class="kd">message</span> <span class="nc">TablesRequest</span> <span class="p">{</span> - <span class="kt">string</span> <span class="na">catalog</span> <span class="o">=</span> <span class="mi">1</span><span class="p">;</span> - <span class="kt">string</span> <span class="na">schema_pattern</span> <span class="o">=</span> <span class="mi">2</span><span class="p">;</span> - <span class="kt">string</span> <span class="na">table_name_pattern</span> <span class="o">=</span> <span class="mi">3</span><span class="p">;</span> - <span class="k">repeated</span> <span class="kt">string</span> <span class="na">type_list</span> <span class="o">=</span> <span class="mi">4</span><span class="p">;</span> - <span class="kt">bool</span> <span class="na">has_type_list</span> <span class="o">=</span> <span class="mi">6</span><span class="p">;</span> - <span class="kt">string</span> <span class="na">connection_id</span> <span class="o">=</span> <span class="mi">7</span><span class="p">;</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-protobuf" data-lang="protobuf">message TablesRequest { + string catalog = 1; + string schema_pattern = 2; + string table_name_pattern = 3; + repeated string type_list = 4; + bool has_type_list = 6; + string connection_id = 7; +}</code></pre></figure> -<p><code>catalog</code> The name of a catalog to restrict fetched tables.</p> +<p><code class="highlighter-rouge">catalog</code> The name of a catalog to restrict fetched tables.</p> -<p><code>schema_pattern</code> A Java Pattern representing schemas to include in fetched tables.</p> +<p><code class="highlighter-rouge">schema_pattern</code> A Java Pattern representing schemas to include in fetched tables.</p> -<p><code>table_name_pattern</code> A Java Pattern representing table names to include in fetched tables.</p> +<p><code class="highlighter-rouge">table_name_pattern</code> A Java Pattern representing table names to include in fetched tables.</p> -<p><code>type_list</code> A list of table types used to restrict fetched tables.</p> +<p><code class="highlighter-rouge">type_list</code> A list of table types used to restrict fetched tables.</p> -<p><code>has_type_list</code> A boolean which denotes if the field <code>type_list</code> was provided.</p> +<p><code class="highlighter-rouge">has_type_list</code> A boolean which denotes if the field <code class="highlighter-rouge">type_list</code> was provided.</p> -<p><code>connection_id</code> The identifier of the connection to fetch the tables from.</p> +<p><code class="highlighter-rouge">connection_id</code> The identifier of the connection to fetch the tables from.</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-protobuf" data-lang="protobuf"><span class="kd">message</span> <span class="nc">TypeInfoRequest</span> <span class="p">{</span> - <span class="kt">string</span> <span class="na">connection_id</span> <span class="o">=</span> <span class="mi">1</span><span class="p">;</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-protobuf" data-lang="protobuf">message TypeInfoRequest { + string connection_id = 1; +}</code></pre></figure> -<p><code>connection_id</code> The identifier of the connection to fetch the types from.</p> +<p><code class="highlighter-rouge">connection_id</code> The identifier of the connection to fetch the types from.</p> <h2 id="responses-1">Responses</h2> <p>The collection of all protobuf objects accepted as requests to Avatica. All response -objects will be wrapped in a <code>WireMessage</code> before being returned from Avatica.</p> +objects will be wrapped in a <code class="highlighter-rouge">WireMessage</code> before being returned from Avatica.</p> <h3 id="closeconnectionresponse">CloseConnectionResponse</h3> <p>A response to the <a href="#closeconnectionrequest">CloseConnectionRequest</a>.</p> -<div class="highlight"><pre><code class="language-protobuf" data-lang="protobuf"><span class="kd">message</span> <span class="nc">CloseConnectionResponse</span> <span class="p">{</span> - <span class="n">RpcMetadata</span> <span class="na">metadata</span> <span class="o">=</span> <span class="mi">1</span><span class="p">;</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-protobuf" data-lang="protobuf">message CloseConnectionResponse { + RpcMetadata metadata = 1; +}</code></pre></figure> -<p><code>metadata</code> <a href="#rpcmetadata">Server metadata</a> about this call.</p> +<p><code class="highlighter-rouge">metadata</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-protobuf" data-lang="protobuf"><span class="kd">message</span> <span class="nc">CloseStatementResponse</span> <span class="p">{</span> - <span class="n">RpcMetadata</span> <span class="na">metadata</span> <span class="o">=</span> <span class="mi">1</span><span class="p">;</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-protobuf" data-lang="protobuf">message CloseStatementResponse { + RpcMetadata metadata = 1; +}</code></pre></figure> -<p><code>metadata</code> <a href="#rpcmetadata">Server metadata</a> about this call.</p> +<p><code class="highlighter-rouge">metadata</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-protobuf" data-lang="protobuf"><span class="kd">message</span> <span class="nc">CommitResponse</span> <span class="p">{</span> +<figure class="highlight"><pre><code class="language-protobuf" data-lang="protobuf">message CommitResponse { -<span class="p">}</span></code></pre></div> +}</code></pre></figure> <p>There are no attributes on this Response.</p> @@ -740,213 +740,213 @@ objects will be wrapped in a <code>WireM <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-protobuf" data-lang="protobuf"><span class="kd">message</span> <span class="nc">ConnectionSyncResponse</span> <span class="p">{</span> - <span class="n">ConnectionProperties</span> <span class="na">conn_props</span> <span class="o">=</span> <span class="mi">1</span><span class="p">;</span> - <span class="n">RpcMetadata</span> <span class="na">metadata</span> <span class="o">=</span> <span class="mi">2</span><span class="p">;</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-protobuf" data-lang="protobuf">message ConnectionSyncResponse { + ConnectionProperties conn_props = 1; + RpcMetadata metadata = 2; +}</code></pre></figure> -<p><code>conn_props</code> The <a href="#connectionproperties">ConnectionProperties</a> that were synchronized.</p> +<p><code class="highlighter-rouge">conn_props</code> The <a href="#connectionproperties">ConnectionProperties</a> that were synchronized.</p> -<p><code>metadata</code> <a href="#rpcmetadata">Server metadata</a> about this call.</p> +<p><code class="highlighter-rouge">metadata</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>statement_id</code> in subsequent calls.</p> +that was created is included in the response. Clients will use this <code class="highlighter-rouge">statement_id</code> in subsequent calls.</p> -<div class="highlight"><pre><code class="language-protobuf" data-lang="protobuf"><span class="kd">message</span> <span class="nc">CreateStatementResponse</span> <span class="p">{</span> - <span class="kt">string</span> <span class="na">connection_id</span> <span class="o">=</span> <span class="mi">1</span><span class="p">;</span> - <span class="kt">uint32</span> <span class="na">statement_id</span> <span class="o">=</span> <span class="mi">2</span><span class="p">;</span> - <span class="n">RpcMetadata</span> <span class="na">metadata</span> <span class="o">=</span> <span class="mi">3</span><span class="p">;</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-protobuf" data-lang="protobuf">message CreateStatementResponse { + string connection_id = 1; + uint32 statement_id = 2; + RpcMetadata metadata = 3; +}</code></pre></figure> -<p><code>connection_id</code> The identifier for the connection used to create the statement.</p> +<p><code class="highlighter-rouge">connection_id</code> The identifier for the connection used to create the statement.</p> -<p><code>statement_id</code> The identifier for the created statement.</p> +<p><code class="highlighter-rouge">statement_id</code> The identifier for the created statement.</p> -<p><code>metadata</code> <a href="#rpcmetadata">Server metadata</a> about this call.</p> +<p><code class="highlighter-rouge">metadata</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-protobuf" data-lang="protobuf"><span class="kd">message</span> <span class="nc">DatabasePropertyResponse</span> <span class="p">{</span> - <span class="k">repeated</span> <span class="n">DatabasePropertyElement</span> <span class="na">props</span> <span class="o">=</span> <span class="mi">1</span><span class="p">;</span> - <span class="n">RpcMetadata</span> <span class="na">metadata</span> <span class="o">=</span> <span class="mi">2</span><span class="p">;</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-protobuf" data-lang="protobuf">message DatabasePropertyResponse { + repeated DatabasePropertyElement props = 1; + RpcMetadata metadata = 2; +}</code></pre></figure> -<p><code>props</code> A collection of <a href="#databaseproperty">DatabaseProperty</a>âs.</p> +<p><code class="highlighter-rouge">props</code> A collection of <a href="#databaseproperty">DatabaseProperty</a>âs.</p> -<p><code>metadata</code> <a href="#rpcmetadata">Server metadata</a> about this call.</p> +<p><code class="highlighter-rouge">metadata</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-protobuf" data-lang="protobuf"><span class="kd">message</span> <span class="nc">ErrorResponse</span> <span class="p">{</span> - <span class="k">repeated</span> <span class="kt">string</span> <span class="na">exceptions</span> <span class="o">=</span> <span class="mi">1</span><span class="p">;</span> - <span class="kt">bool</span> <span class="na">has_exceptions</span> <span class="o">=</span> <span class="mi">7</span><span class="p">;</span> - <span class="kt">string</span> <span class="na">error_message</span> <span class="o">=</span> <span class="mi">2</span><span class="p">;</span> - <span class="n">Severity</span> <span class="na">severity</span> <span class="o">=</span> <span class="mi">3</span><span class="p">;</span> - <span class="kt">uint32</span> <span class="na">error_code</span> <span class="o">=</span> <span class="mi">4</span><span class="p">;</span> - <span class="kt">string</span> <span class="na">sql_state</span> <span class="o">=</span> <span class="mi">5</span><span class="p">;</span> - <span class="n">RpcMetadata</span> <span class="na">metadata</span> <span class="o">=</span> <span class="mi">6</span><span class="p">;</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-protobuf" data-lang="protobuf">message ErrorResponse { + repeated string exceptions = 1; + bool has_exceptions = 7; + string error_message = 2; + Severity severity = 3; + uint32 error_code = 4; + string sql_state = 5; + RpcMetadata metadata = 6; +}</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>has_exceptions</code> A boolean which denotes the presence of <code>exceptions</code>.</p> +<p><code class="highlighter-rouge">has_exceptions</code> A boolean which denotes the presence of <code class="highlighter-rouge">exceptions</code>.</p> -<p><code>error_message</code> A human-readable error message.</p> +<p><code class="highlighter-rouge">error_message</code> A human-readable error message.</p> -<p><code>error_code</code> A numeric code for this error.</p> +<p><code class="highlighter-rouge">error_code</code> A numeric code for this error.</p> -<p><code>sql_state</code> A five character alphanumeric code for this error.</p> +<p><code class="highlighter-rouge">sql_state</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>metadata</code> <a href="#rpcmetadata">Server metadata</a> about this call.</p> +<p><code class="highlighter-rouge">metadata</code> <a href="#rpcmetadata">Server metadata</a> about this call.</p> <h3 id="executebatchresponse">ExecuteBatchResponse</h3> <p>A response to the <a href="#executebatchrequest">ExecuteBatchRequest</a> and <a href="#prepareandexecutebatchrequest">PrepareAndExecuteBatchRequest</a>.</p> -<div class="highlight"><pre><code class="language-protobuf" data-lang="protobuf"><span class="kd">message</span> <span class="nc">ExecuteBatchResponse</span> <span class="p">{</span> - <span class="kt">string</span> <span class="na">connection_id</span> <span class="o">=</span> <span class="mi">1</span><span class="p">;</span> - <span class="kt">uint32</span> <span class="na">statement_id</span> <span class="o">=</span> <span class="mi">2</span><span class="p">;</span> - <span class="k">repeated</span> <span class="kt">uint32</span> <span class="na">update_counts</span> <span class="o">=</span> <span class="mi">3</span><span class="p">;</span> - <span class="kt">bool</span> <span class="na">missing_statement</span> <span class="o">=</span> <span class="mi">4</span><span class="p">;</span> - <span class="n">RpcMetadata</span> <span class="na">metadata</span> <span class="o">=</span> <span class="mi">5</span><span class="p">;</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-protobuf" data-lang="protobuf">message ExecuteBatchResponse { + string connection_id = 1; + uint32 statement_id = 2; + repeated uint32 update_counts = 3; + bool missing_statement = 4; + RpcMetadata metadata = 5; +}</code></pre></figure> -<p><code>connection_id</code> The ID referring to the connection that was used.</p> +<p><code class="highlighter-rouge">connection_id</code> The ID referring to the connection that was used.</p> -<p><code>statment_id</code> The ID referring to the statement that was used.</p> +<p><code class="highlighter-rouge">statment_id</code> The ID referring to the statement that was used.</p> -<p><code>update_counts</code> An array of integer values corresponding to the update count for each update in the batch.</p> +<p><code class="highlighter-rouge">update_counts</code> An array of integer values corresponding to the update count for each update in the batch.</p> -<p><code>missing_statement</code> A boolean which denotes if the request failed due to a missing statement.</p> +<p><code class="highlighter-rouge">missing_statement</code> A boolean which denotes if the request failed due to a missing statement.</p> -<p><code>metadata</code> <a href="#rpcmetadata">Server metadata</a> about this call.</p> +<p><code class="highlighter-rouge">metadata</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-protobuf" data-lang="protobuf"><span class="kd">message</span> <span class="nc">ExecuteResponse</span> <span class="p">{</span> - <span class="k">repeated</span> <span class="n">ResultSetResponse</span> <span class="na">results</span> <span class="o">=</span> <span class="mi">1</span><span class="p">;</span> - <span class="kt">bool</span> <span class="na">missing_statement</span> <span class="o">=</span> <span class="mi">2</span><span class="p">;</span> - <span class="n">RpcMetadata</span> <span class="na">metadata</span> <span class="o">=</span> <span class="mi">3</span><span class="p">;</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-protobuf" data-lang="protobuf">message ExecuteResponse { + repeated ResultSetResponse results = 1; + bool missing_statement = 2; + RpcMetadata metadata = 3; +}</code></pre></figure> -<p><code>results</code> An array of <a href="#resultsetresponse">ResultSetResponse</a>s.</p> +<p><code class="highlighter-rouge">results</code> An array of <a href="#resultsetresponse">ResultSetResponse</a>s.</p> -<p><code>missing_statement</code> A boolean which denotes if the request failed due to a missing statement.</p> +<p><code class="highlighter-rouge">missing_statement</code> A boolean which denotes if the request failed due to a missing statement.</p> -<p><code>metadata</code> <a href="#rpcmetadata">Server metadata</a> about this call.</p> +<p><code class="highlighter-rouge">metadata</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-protobuf" data-lang="protobuf"><span class="kd">message</span> <span class="nc">FetchResponse</span> <span class="p">{</span> - <span class="n">Frame</span> <span class="na">frame</span> <span class="o">=</span> <span class="mi">1</span><span class="p">;</span> - <span class="kt">bool</span> <span class="na">missing_statement</span> <span class="o">=</span> <span class="mi">2</span><span class="p">;</span> - <span class="kt">bool</span> <span class="na">missing_results</span> <span class="o">=</span> <span class="mi">3</span><span class="p">;</span> - <span class="n">RpcMetadata</span> <span class="na">metadata</span> <span class="o">=</span> <span class="mi">4</span><span class="p">;</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-protobuf" data-lang="protobuf">message FetchResponse { + Frame frame = 1; + bool missing_statement = 2; + bool missing_results = 3; + RpcMetadata metadata = 4; +}</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>missing_statement</code> A boolean which denotes if the request failed due to a missing Statement.</p> +<p><code class="highlighter-rouge">missing_statement</code> A boolean which denotes if the request failed due to a missing Statement.</p> -<p><code>missing_results</code> A boolean which denotes if the request failed due to a missing ResultSet.</p> +<p><code class="highlighter-rouge">missing_results</code> A boolean which denotes if the request failed due to a missing ResultSet.</p> -<p><code>metadata</code> <a href="#rpcmetadata">Server metadata</a> about this call.</p> +<p><code class="highlighter-rouge">metadata</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-protobuf" data-lang="protobuf"><span class="kd">message</span> <span class="nc">OpenConnectionResponse</span> <span class="p">{</span> - <span class="n">RpcMetadata</span> <span class="na">metadata</span> <span class="o">=</span> <span class="mi">1</span><span class="p">;</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-protobuf" data-lang="protobuf">message OpenConnectionResponse { + RpcMetadata metadata = 1; +}</code></pre></figure> -<p><code>metadata</code> <a href="#rpcmetadata">Server metadata</a> about this call.</p> +<p><code class="highlighter-rouge">metadata</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-protobuf" data-lang="protobuf"><span class="kd">message</span> <span class="nc">PrepareResponse</span> <span class="p">{</span> - <span class="n">StatementHandle</span> <span class="na">statement</span> <span class="o">=</span> <span class="mi">1</span><span class="p">;</span> - <span class="n">RpcMetadata</span> <span class="na">metadata</span> <span class="o">=</span> <span class="mi">2</span><span class="p">;</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-protobuf" data-lang="protobuf">message PrepareResponse { + StatementHandle statement = 1; + RpcMetadata metadata = 2; +}</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>metadata</code> <a href="#rpcmetadata">Server metadata</a> about this call.</p> +<p><code class="highlighter-rouge">metadata</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-protobuf" data-lang="protobuf"><span class="kd">message</span> <span class="nc">ResultSetResponse</span> <span class="p">{</span> - <span class="kt">string</span> <span class="na">connection_id</span> <span class="o">=</span> <span class="mi">1</span><span class="p">;</span> - <span class="kt">uint32</span> <span class="na">statement_id</span> <span class="o">=</span> <span class="mi">2</span><span class="p">;</span> - <span class="kt">bool</span> <span class="na">own_statement</span> <span class="o">=</span> <span class="mi">3</span><span class="p">;</span> - <span class="n">Signature</span> <span class="na">signature</span> <span class="o">=</span> <span class="mi">4</span><span class="p">;</span> - <span class="n">Frame</span> <span class="na">first_frame</span> <span class="o">=</span> <span class="mi">5</span><span class="p">;</span> - <span class="kt">uint64</span> <span class="na">update_count</span> <span class="o">=</span> <span class="mi">6</span><span class="p">;</span> - <span class="n">RpcMetadata</span> <span class="na">metadata</span> <span class="o">=</span> <span class="mi">7</span><span class="p">;</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-protobuf" data-lang="protobuf">message ResultSetResponse { + string connection_id = 1; + uint32 statement_id = 2; + bool own_statement = 3; + Signature signature = 4; + Frame first_frame = 5; + uint64 update_count = 6; + RpcMetadata metadata = 7; +}</code></pre></figure> -<p><code>connection_id</code> The identifier for the connection used to generate this response.</p> +<p><code class="highlighter-rouge">connection_id</code> The identifier for the connection used to generate this response.</p> -<p><code>statement_id</code> The identifier for the statement used to generate this response.</p> +<p><code class="highlighter-rouge">statement_id</code> The identifier for the statement used to generate this response.</p> -<p><code>own_statement</code> Whether the result set has its own dedicated statement. If true, the server must automatically close the +<p><code class="highlighter-rouge">own_statement</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>first_frame</code> A optional nested object <a href="#frame">Frame</a></p> +<p><code class="highlighter-rouge">first_frame</code> A optional nested object <a href="#frame">Frame</a></p> -<p><code>update_count</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">update_count</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>metadata</code> <a href="#rpcmetadata">Server metadata</a> about this call.</p> +<p><code class="highlighter-rouge">metadata</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-protobuf" data-lang="protobuf"><span class="kd">message</span> <span class="nc">RollbackResponse</span> <span class="p">{</span> +<figure class="highlight"><pre><code class="language-protobuf" data-lang="protobuf">message RollbackResponse { -<span class="p">}</span></code></pre></div> +}</code></pre></figure> <p>There are no 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-protobuf" data-lang="protobuf"><span class="kd">message</span> <span class="nc">SyncResultsResponse</span> <span class="p">{</span> - <span class="kt">bool</span> <span class="na">missing_statement</span> <span class="o">=</span> <span class="mi">1</span><span class="p">;</span> - <span class="kt">bool</span> <span class="na">more_results</span> <span class="o">=</span> <span class="mi">2</span><span class="p">;</span> - <span class="n">RpcMetadata</span> <span class="na">metadata</span> <span class="o">=</span> <span class="mi">3</span><span class="p">;</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-protobuf" data-lang="protobuf">message SyncResultsResponse { + bool missing_statement = 1; + bool more_results = 2; + RpcMetadata metadata = 3; +}</code></pre></figure> -<p><code>more_results</code> A boolean which denotes if results exist for the ResultSet being âsyncedâ per the request.</p> +<p><code class="highlighter-rouge">more_results</code> A boolean which denotes if results exist for the ResultSet being âsyncedâ per the request.</p> -<p><code>missing_statement</code> A boolean which denotes if the statement for the ResultSet still exists.</p> +<p><code class="highlighter-rouge">missing_statement</code> A boolean which denotes if the statement for the ResultSet still exists.</p> -<p><code>metadata</code> <a href="#rpcmetadata">Server metadata</a> about this call.</p> +<p><code class="highlighter-rouge">metadata</code> <a href="#rpcmetadata">Server metadata</a> about this call.</p> <h2 id="miscellaneous-1">Miscellaneous</h2> @@ -955,105 +955,105 @@ 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-protobuf" data-lang="protobuf"><span class="kd">message</span> <span class="nc">AvaticaParameter</span> <span class="p">{</span> - <span class="kt">bool</span> <span class="na">signed</span> <span class="o">=</span> <span class="mi">1</span><span class="p">;</span> - <span class="kt">uint32</span> <span class="na">precision</span> <span class="o">=</span> <span class="mi">2</span><span class="p">;</span> - <span class="kt">uint32</span> <span class="na">scale</span> <span class="o">=</span> <span class="mi">3</span><span class="p">;</span> - <span class="kt">uint32</span> <span class="na">parameter_type</span> <span class="o">=</span> <span class="mi">4</span><span class="p">;</span> - <span class="kt">string</span> <span class="na">class_name</span> <span class="o">=</span> <span class="mi">5</span><span class="p">;</span> - <span class="kt">string</span> <span class="na">class_name</span> <span class="o">=</span> <span class="mi">6</span><span class="p">;</span> - <span class="kt">string</span> <span class="na">name</span> <span class="o">=</span> <span class="mi">7</span><span class="p">;</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-protobuf" data-lang="protobuf">message AvaticaParameter { + bool signed = 1; + uint32 precision = 2; + uint32 scale = 3; + uint32 parameter_type = 4; + string class_name = 5; + string class_name = 6; + string name = 7; +}</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>parameter_type</code> An integer corresponding to the JDBC Types class denoting the columnâs type.</p> +<p><code class="highlighter-rouge">parameter_type</code> An integer corresponding to the JDBC Types class denoting the columnâs type.</p> -<p><code>type_name</code> The JDBC type name for this column.</p> +<p><code class="highlighter-rouge">type_name</code> The JDBC type name for this column.</p> -<p><code>class_name</code> The Java class backing the JDBC type for this column.</p> +<p><code class="highlighter-rouge">class_name</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> <p>This enumeration describes the various levels of concern for an error in the Avatica server.</p> -<div class="highlight"><pre><code class="language-protobuf" data-lang="protobuf"><span class="kd">enum</span> <span class="n">Severity</span> <span class="p">{</span> - <span class="na">UNKNOWN_SEVERITY</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span> - <span class="na">FATAL_SEVERITY</span> <span class="o">=</span> <span class="mi">1</span><span class="p">;</span> - <span class="na">ERROR_SEVERITY</span> <span class="o">=</span> <span class="mi">2</span><span class="p">;</span> - <span class="na">WARNING_SEVERITY</span> <span class="o">=</span> <span class="mi">3</span><span class="p">;</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-protobuf" data-lang="protobuf">enum Severity { + UNKNOWN_SEVERITY = 0; + FATAL_SEVERITY = 1; + ERROR_SEVERITY = 2; + WARNING_SEVERITY = 3; +}</code></pre></figure> <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-protobuf" data-lang="protobuf"><span class="kd">message</span> <span class="nc">AvaticaType</span> <span class="p">{</span> - <span class="kt">uint32</span> <span class="na">id</span> <span class="o">=</span> <span class="mi">1</span><span class="p">;</span> - <span class="kt">string</span> <span class="na">name</span> <span class="o">=</span> <span class="mi">2</span><span class="p">;</span> - <span class="n">Rep</span> <span class="na">rep</span> <span class="o">=</span> <span class="mi">3</span><span class="p">;</span> - <span class="k">repeated</span> <span class="n">ColumnMetaData</span> <span class="na">columns</span> <span class="o">=</span> <span class="mi">4</span><span class="p">;</span> - <span class="n">AvaticaType</span> <span class="na">component</span> <span class="o">=</span> <span class="mi">5</span><span class="p">;</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-protobuf" data-lang="protobuf">message AvaticaType { + uint32 id = 1; + string name = 2; + Rep rep = 3; + repeated ColumnMetaData columns = 4; + AvaticaType component = 5; +}</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-protobuf" data-lang="protobuf"><span class="kd">message</span> <span class="nc">ColumnMetaData</span> <span class="p">{</span> - <span class="kt">uint32</span> <span class="na">ordinal</span> <span class="o">=</span> <span class="mi">1</span><span class="p">;</span> - <span class="kt">bool</span> <span class="na">auto_increment</span> <span class="o">=</span> <span class="mi">2</span><span class="p">;</span> - <span class="kt">bool</span> <span class="na">case_sensitive</span> <span class="o">=</span> <span class="mi">3</span><span class="p">;</span> - <span class="kt">bool</span> <span class="na">searchable</span> <span class="o">=</span> <span class="mi">4</span><span class="p">;</span> - <span class="kt">bool</span> <span class="na">currency</span> <span class="o">=</span> <span class="mi">5</span><span class="p">;</span> - <span class="kt">uint32</span> <span class="na">nullable</span> <span class="o">=</span> <span class="mi">6</span><span class="p">;</span> - <span class="kt">bool</span> <span class="na">signed</span> <span class="o">=</span> <span class="mi">7</span><span class="p">;</span> - <span class="kt">uint32</span> <span class="na">display_size</span> <span class="o">=</span> <span class="mi">8</span><span class="p">;</span> - <span class="kt">string</span> <span class="na">label</span> <span class="o">=</span> <span class="mi">9</span><span class="p">;</span> - <span class="kt">string</span> <span class="na">column_name</span> <span class="o">=</span> <span class="mi">10</span><span class="p">;</span> - <span class="kt">string</span> <span class="na">schema_name</span> <span class="o">=</span> <span class="mi">11</span><span class="p">;</span> - <span class="kt">uint32</span> <span class="na">precision</span> <span class="o">=</span> <span class="mi">12</span><span class="p">;</span> - <span class="kt">uint32</span> <span class="na">scale</span> <span class="o">=</span> <span class="mi">13</span><span class="p">;</span> - <span class="kt">string</span> <span class="na">table_name</span> <span class="o">=</span> <span class="mi">14</span><span class="p">;</span> - <span class="kt">string</span> <span class="na">catalog_name</span> <span class="o">=</span> <span class="mi">15</span><span class="p">;</span> - <span class="kt">bool</span> <span class="na">read_only</span> <span class="o">=</span> <span class="mi">16</span><span class="p">;</span> - <span class="kt">bool</span> <span class="na">writable</span> <span class="o">=</span> <span class="mi">17</span><span class="p">;</span> - <span class="kt">bool</span> <span class="na">definitely_writable</span> <span class="o">=</span> <span class="mi">18</span><span class="p">;</span> - <span class="kt">string</span> <span class="na">column_class_name</span> <span class="o">=</span> <span class="mi">19</span><span class="p">;</span> - <span class="n">AvaticaType</span> <span class="na">type</span> <span class="o">=</span> <span class="mi">20</span><span class="p">;</span> -<span class="p">}</span></code></pre></div> - -<p><code>ordinal</code> A positional offset number.</p> - -<p><code>auto_increment</code> A boolean denoting whether the column is automatically incremented.</p> +<figure class="highlight"><pre><code class="language-protobuf" data-lang="protobuf">message ColumnMetaData { + uint32 ordinal = 1; + bool auto_increment = 2; + bool case_sensitive = 3; + bool searchable = 4; + bool currency = 5; + uint32 nullable = 6; + bool signed = 7; + uint32 display_size = 8; + string label = 9; + string column_name = 10; + string schema_name = 11; + uint32 precision = 12; + uint32 scale = 13; + string table_name = 14; + string catalog_name = 15; + bool read_only = 16; + bool writable = 17; + bool definitely_writable = 18; + string column_class_name = 19; + AvaticaType type = 20; +}</code></pre></figure> + +<p><code class="highlighter-rouge">ordinal</code> A positional offset number.</p> + +<p><code class="highlighter-rouge">auto_increment</code> A boolean denoting whether the column is automatically incremented.</p> -<p><code>case_sensitive</code> A boolean denoting whether the column is case sensitive.</p> +<p><code class="highlighter-rouge">case_sensitive</code> A boolean denoting whether the column is case sensitive.</p> -<p><code>searchable</code> A boolean denoting whether this column supports all WHERE search clauses.</p> +<p><code class="highlighter-rouge">searchable</code> A boolean denoting whether this column supports all WHERE search clauses.</p> -<p><code>currency</code> A boolean denoting whether this column represents currency.</p> +<p><code class="highlighter-rouge">currency</code> A boolean denoting whether this column represents currency.</p> -<p><code>nullable</code> A number denoting whether this column supports null values.</p> +<p><code class="highlighter-rouge">nullable</code> A number denoting whether this column supports null values.</p> <ul> <li>0 = No null values are allowed</li> @@ -1061,61 +1061,61 @@ types of the complex parent type.</p> <li>2 = It is unknown if null values are allowed</li> </ul> -<p><code>signed</code> A boolean denoting whether the column is a signed numeric.</p> +<p><code class="highlighter-rouge">signed</code> A boolean denoting whether the column is a signed numeric.</p> -<p><code>display_size</code> The character width of the column.</p> +<p><code class="highlighter-rouge">display_size</code> The character width of the column.</p> -<p><code>label</code> A description for this column.</p> +<p><code class="highlighter-rouge">label</code> A description for this column.</p> -<p><code>column_name</code> The name of the column.</p> +<p><code class="highlighter-rouge">column_name</code> The name of the column.</p> -<p><code>schema_name</code> The schema to which this column belongs.</p> +<p><code class="highlighter-rouge">schema_name</code> The schema to which this column belongs.</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>table_name</code> The name of the table to which this column belongs.</p> +<p><code class="highlighter-rouge">table_name</code> The name of the table to which this column belongs.</p> -<p><code>catalog_name</code> The name of the catalog to which this column belongs.</p> +<p><code class="highlighter-rouge">catalog_name</code> The name of the catalog to which this column belongs.</p> -<p><code>type</code> A nested <a href="#avaticatype">AvaticaType</a> representing the type of the column.</p> +<p><code class="highlighter-rouge">type</code> A nested <a href="#avaticatype">AvaticaType</a> representing the type of the column.</p> -<p><code>read_only</code> A boolean denoting whether the column is read-only.</p> +<p><code class="highlighter-rouge">read_only</code> A boolean denoting whether the column is read-only.</p> -<p><code>writable</code> A boolean denoting whether the column is possible to be updated.</p> +<p><code class="highlighter-rouge">writable</code> A boolean denoting whether the column is possible to be updated.</p> -<p><code>definitely_writable</code> A boolean denoting whether the column definitely can be updated.</p> +<p><code class="highlighter-rouge">definitely_writable</code> A boolean denoting whether the column definitely can be updated.</p> -<p><code>column_class_name</code> The name of the Java class backing the columnâs type.</p> +<p><code class="highlighter-rouge">column_class_name</code> The name of the Java class backing the columnâs type.</p> <h3 id="connectionproperties">ConnectionProperties</h3> <p>This object represents the properties for a given JDBC Connection.</p> -<div class="highlight"><pre><code class="language-protobuf" data-lang="protobuf"><span class="kd">message</span> <span class="nc">ConnectionProperties</span> <span class="p">{</span> - <span class="kt">bool</span> <span class="na">is_dirty</span> <span class="o">=</span> <span class="mi">1</span><span class="p">;</span> - <span class="kt">bool</span> <span class="na">auto_commit</span> <span class="o">=</span> <span class="mi">2</span><span class="p">;</span> - <span class="kt">bool</span> <span class="na">has_auto_commit</span> <span class="o">=</span> <span class="mi">7</span><span class="p">;</span> - <span class="kt">bool</span> <span class="na">read_only</span> <span class="o">=</span> <span class="mi">3</span><span class="p">;</span> - <span class="kt">bool</span> <span class="na">has_read_only</span> <span class="o">=</span> <span class="mi">8</span><span class="p">;</span> - <span class="kt">uint32</span> <span class="na">transaction_isolation</span> <span class="o">=</span> <span class="mi">4</span><span class="p">;</span> - <span class="kt">string</span> <span class="na">catalog</span> <span class="o">=</span> <span class="mi">5</span><span class="p">;</span> - <span class="kt">string</span> <span class="na">schema</span> <span class="o">=</span> <span class="mi">6</span><span class="p">;</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-protobuf" data-lang="protobuf">message ConnectionProperties { + bool is_dirty = 1; + bool auto_commit = 2; + bool has_auto_commit = 7; + bool read_only = 3; + bool has_read_only = 8; + uint32 transaction_isolation = 4; + string catalog = 5; + string schema = 6; +}</code></pre></figure> -<p><code>is_dirty</code> A boolean denoting if the properties have been altered.</p> +<p><code class="highlighter-rouge">is_dirty</code> A boolean denoting if the properties have been altered.</p> -<p><code>auto_commit</code> A boolean denoting if autoCommit is enabled for transactions.</p> +<p><code class="highlighter-rouge">auto_commit</code> A boolean denoting if autoCommit is enabled for transactions.</p> -<p><code>has_auto_commit</code> A boolean denoting if <code>auto_commit</code> was set.</p> +<p><code class="highlighter-rouge">has_auto_commit</code> A boolean denoting if <code class="highlighter-rouge">auto_commit</code> was set.</p> -<p><code>read_only</code> A boolean denoting if a JDBC connection is read-only.</p> +<p><code class="highlighter-rouge">read_only</code> A boolean denoting if a JDBC connection is read-only.</p> -<p><code>has_read_only</code> A boolean denoting if <code>read_only</code> was set.</p> +<p><code class="highlighter-rouge">has_read_only</code> A boolean denoting if <code class="highlighter-rouge">read_only</code> was set.</p> -<p><code>transaction_isolation</code> 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 class="highlighter-rouge">transaction_isolation</code> An integer which denotes the level of transactions isolation per the JDBC +specification. This value is analogous to the values defined in <code class="highlighter-rouge">java.sql.Connection</code>.</p> <ul> <li>0 = Transactions are not supported</li> @@ -1125,272 +1125,272 @@ specification. This value is analogous t <li>8 = Dirty reads, non-repeatable reads, and phantom reads are all prevented.</li> </ul> -<p><code>catalog</code> The name of a catalog to use when fetching connection properties.</p> +<p><code class="highlighter-rouge">catalog</code> The name of a catalog to use when fetching connection properties.</p> -<p><code>schema</code> The name of the schema to use when fetching connection properties.</p> +<p><code class="highlighter-rouge">schema</code> The name of the schema to use when fetching connection properties.</p> <h3 id="cursorfactory">CursorFactory</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-protobuf" data-lang="protobuf"><span class="kd">message</span> <span class="nc">CursorFactory</span> <span class="p">{</span> - <span class="kd">enum</span> <span class="n">Style</span> <span class="p">{</span> - <span class="na">OBJECT</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span> - <span class="na">RECORD</span> <span class="o">=</span> <span class="mi">1</span><span class="p">;</span> - <span class="na">RECORD_PROJECTION</span> <span class="o">=</span> <span class="mi">2</span><span class="p">;</span> - <span class="na">ARRAY</span> <span class="o">=</span> <span class="mi">3</span><span class="p">;</span> - <span class="na">LIST</span> <span class="o">=</span> <span class="mi">4</span><span class="p">;</span> - <span class="na">MAP</span> <span class="o">=</span> <span class="mi">5</span><span class="p">;</span> - <span class="p">}</span> - - <span class="n">Style</span> <span class="na">style</span> <span class="o">=</span> <span class="mi">1</span><span class="p">;</span> - <span class="kt">string</span> <span class="na">class_name</span> <span class="o">=</span> <span class="mi">2</span><span class="p">;</span> - <span class="k">repeated</span> <span class="kt">string</span> <span class="na">field_names</span> <span class="o">=</span> <span class="mi">3</span><span class="p">;</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-protobuf" data-lang="protobuf">message CursorFactory { + enum Style { + OBJECT = 0; + RECORD = 1; + RECORD_PROJECTION = 2; + ARRAY = 3; + LIST = 4; + MAP = 5; + } + + Style style = 1; + string class_name = 2; + repeated string field_names = 3; +}</code></pre></figure> -<p><code>style</code> A string denoting the <a href="#style">Style</a> of the contained objects.</p> +<p><code class="highlighter-rouge">style</code> A string denoting the <a href="#style">Style</a> of the contained objects.</p> -<p><code>class_name</code> The name of the for <code>RECORD</code> or <code>RECORD_PROJECTION</code>.</p> +<p><code class="highlighter-rouge">class_name</code> The name of the for <code class="highlighter-rouge">RECORD</code> or <code class="highlighter-rouge">RECORD_PROJECTION</code>.</p> <h3 id="databaseproperty">DatabaseProperty</h3> <p>This object represents the exposed database properties for a Connection through the Avatica server.</p> -<div class="highlight"><pre><code class="language-protobuf" data-lang="protobuf"><span class="kd">message</span> <span class="nc">DatabaseProperty</span> <span class="p">{</span> - <span class="kt">string</span> <span class="na">name</span> <span class="o">=</span> <span class="mi">1</span><span class="p">;</span> - <span class="k">repeated</span> <span class="kt">string</span> <span class="na">functions</span> <span class="o">=</span> <span class="mi">2</span><span class="p">;</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-protobuf" data-lang="protobuf">message DatabaseProperty { + string name = 1; + repeated string functions = 2; +}</code></pre></figure> -<p><code>name</code> The name of the database property.</p> +<p><code class="highlighter-rouge">name</code> The name of the database property.</p> -<p><code>functions</code> A collection of values for the property.</p> +<p><code class="highlighter-rouge">functions</code> A collection of values for the property.</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-protobuf" data-lang="protobuf"><span class="kd">message</span> <span class="nc">Frame</span> <span class="p">{</span> - <span class="kt">uint64</span> <span class="na">offset</span> <span class="o">=</span> <span class="mi">1</span><span class="p">;</span> - <span class="kt">bool</span> <span class="na">done</span> <span class="o">=</span> <span class="mi">2</span><span class="p">;</span> - <span class="k">repeated</span> <span class="n">Row</span> <span class="na">rows</span> <span class="o">=</span> <span class="mi">3</span><span class="p">;</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-protobuf" data-lang="protobuf">message Frame { + uint64 offset = 1; + bool done = 2; + repeated Row rows = 3; +}</code></pre></figure> -<p><code>offset</code> The starting position of these <code>rows</code> in the encompassing result set.</p> +<p><code class="highlighter-rouge">offset</code> The starting position of these <code class="highlighter-rouge">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 class="highlighter-rouge">done</code> A boolean denoting whether more results exist for this result set.</p> -<p><code>rows</code> A collection of <a href="#row">Row</a>s.</p> +<p><code class="highlighter-rouge">rows</code> A collection of <a href="#row">Row</a>s.</p> <h3 id="row">Row</h3> <p>This object represents a row in a relational database table.</p> -<div class="highlight"><pre><code class="language-protobuf" data-lang="protobuf"><span class="kd">message</span> <span class="nc">Row</span> <span class="p">{</span> - <span class="k">repeated</span> <span class="n">ColumnValue</span> <span class="na">value</span> <span class="o">=</span> <span class="mi">1</span><span class="p">;</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-protobuf" data-lang="protobuf">message Row { + repeated ColumnValue value = 1; +}</code></pre></figure> -<p><code>value</code> A collection of <a href="#columnvalue">ColumnValue</a>s, the columns in the row.</p> +<p><code class="highlighter-rouge">value</code> A collection of <a href="#columnvalue">ColumnValue</a>s, the columns in the row.</p> <h3 id="columnvalue">ColumnValue</h3> -<div class="highlight"><pre><code class="language-protobuf" data-lang="protobuf"><span class="kd">message</span> <span class="nc">ColumnValue</span> <span class="p">{</span> - <span class="k">repeated</span> <span class="n">TypedValue</span> <span class="na">value</span> <span class="o">=</span> <span class="mi">1</span><span class="p">;</span> <span class="c1">// Deprecated!</span> - <span class="k">repeated</span> <span class="n">ColumnValue</span> <span class="na">array_value</span> <span class="o">=</span> <span class="mi">2</span><span class="p">;</span> - <span class="n">boolean</span> <span class="na">has_array_value</span> <span class="o">=</span> <span class="mi">3</span><span class="p">;</span> - <span class="n">TypedValue</span> <span class="na">scalar_value</span> <span class="o">=</span> <span class="mi">4</span><span class="p">;</span> -<span class="p">}</span></code></pre></div> +<figure class="highlight"><pre><code class="language-protobuf" data-lang="protobuf">message ColumnValue { + repeated TypedValue value = 1; // Deprecated! + repeated ColumnValue array_value = 2; + boolean has_array_value = 3; + TypedValue scalar_value = 4; +}</code></pre></figure> -<p><code>value</code> The pre Calcite-1.6 means of serializing <a href="#typedvalue">TypedValue</a>s. Not used anymore.</p> +<p><code class="highlighter-rouge">value</code> The pre Calcite-1.6 means of serializing <a href="#typedvalue">TypedValue</a>s. Not used anymore.</p> -<p><code>array_value</code> The value of this column if it is an array (not a scalar).</p> +<p><code class="highlighter-rouge">array_value</code> The value of this column if it is an array (not a scalar).</p> -<p><code>has_array_value</code> Should be set to true if <code>array_value</code> is set.</p> +<p><code class="highlighter-rouge">has_array_value</code> Should be set to true if <code class="highlighter-rouge">array_value</code> is set.</p> -<p><code>scalar_value</code> The value of this column if it is a scalar (not an array).</p> +<p><code class="highlighter-rouge">scalar_value</code> The value of this column if it is a scalar (not an array).</p> <h3 id="querystate">QueryState</h3>
[... 964 lines stripped ...]
