This is an automated email from the ASF dual-hosted git repository.
elserj pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/calcite-site.git
The following commit(s) were added to refs/heads/master by this push:
new 0928ed5 [CALCITE-4367] Site: Publish Avatica protocol doc improvements
0928ed5 is described below
commit 0928ed5545bf9b700e0143e1d71aba97af4b3150
Author: Josh Elser <[email protected]>
AuthorDate: Wed Dec 30 21:30:10 2020 -0500
[CALCITE-4367] Site: Publish Avatica protocol doc improvements
---
avatica/docs/json_reference.html | 8 ++++++--
avatica/docs/protobuf_reference.html | 3 ++-
2 files changed, 8 insertions(+), 3 deletions(-)
diff --git a/avatica/docs/json_reference.html b/avatica/docs/json_reference.html
index f16aa5c..4358c0d 100644
--- a/avatica/docs/json_reference.html
+++ b/avatica/docs/json_reference.html
@@ -838,6 +838,7 @@ which uniquely identifies the concrete Request from all
other Requests.</p>
<figure class="highlight"><pre><code class="language-json"
data-lang="json"><span class="p">{</span><span class="w">
</span><span class="s2">"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="s2">"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 class="highlighter-rouge">connectionId</code> (required string) The
identifier of the connection to use when fetching the database properties.</p>
@@ -1009,9 +1010,9 @@ which uniquely identifies the concrete Request from all
other Requests.</p>
<p><code class="highlighter-rouge">connection_id</code> The identifier for the
connection to fetch schemas from.</p>
-<p><code class="highlighter-rouge">catalog</code> (required string) The name
of the catalog to fetch the schema from.</p>
+<p><code class="highlighter-rouge">catalog</code> (optional string) The name
of the catalog to fetch the schema from.</p>
-<p><code class="highlighter-rouge">schemaPattern</code> (required string) A
Java pattern of schemas to fetch.</p>
+<p><code class="highlighter-rouge">schemaPattern</code> (optional string) A
Java pattern of schemas to fetch.</p>
<h3 id="tabletypesrequest">TableTypesRequest</h3>
@@ -1494,6 +1495,9 @@ specification. This value is analogous to the values
defined in <code class="hig
<p><code class="highlighter-rouge">schema</code> (optional string) The name of
the schema to include when fetching connection properties.</p>
+<p><code class="highlighter-rouge">isDirty</code> (internal boolean) A boolean
used for internal purposes only (not required by the Avatica protocol).
+This field will be removed from the protocol in future releases.</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>
diff --git a/avatica/docs/protobuf_reference.html
b/avatica/docs/protobuf_reference.html
index ef89b9f..0f1b9d9 100644
--- a/avatica/docs/protobuf_reference.html
+++ b/avatica/docs/protobuf_reference.html
@@ -1496,7 +1496,8 @@ types of the complex parent type.</p>
<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></figure>
-<p><code class="highlighter-rouge">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. This field should not be present as it
+never and will be removed from the protocol in future releases.</p>
<p><code class="highlighter-rouge">auto_commit</code> A boolean denoting if
autoCommit is enabled for transactions.</p>
