[calcite-avatica] branch master updated: [CALCITE-4367] Correct Avatica protocol docs

[elserj]

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-avatica.git


The following commit(s) were added to refs/heads/master by this push:
     new e27b204  [CALCITE-4367] Correct Avatica protocol docs
e27b204 is described below

commit e27b204392c4485681de0e574ebf5b96275b9788
Author: Josh Elser <els...@apache.org>
AuthorDate: Wed Dec 23 20:46:45 2020 -0500

    [CALCITE-4367] Correct Avatica protocol docs
    
    isDirty needs to be deprecated and removed as it should
    not have been in the protocol to begin with.
    
    Closes #131
    
    Signed-off-by: Kevin Risden <kris...@apache.org>
---
 site/_docs/json_reference.md     | 8 ++++++--
 site/_docs/protobuf_reference.md | 3 ++-
 2 files changed, 8 insertions(+), 3 deletions(-)

diff --git a/site/_docs/json_reference.md b/site/_docs/json_reference.md
index 6340c59..82fb40d 100644
--- a/site/_docs/json_reference.md
+++ b/site/_docs/json_reference.md
@@ -229,6 +229,7 @@ This request is used to fetch all <a 
href="#databaseproperty">database propertie
 {% highlight json %}
 {
   "request": "databaseProperties",
+  "connectionId": "000000-0000-0000-00000000"
 }
 {% endhighlight %}
 
@@ -421,9 +422,9 @@ This request is used to fetch the schemas matching the 
provided criteria in the
 
 `connection_id` The identifier for the connection to fetch schemas from.
 
-`catalog` (required string) The name of the catalog to fetch the schema from.
+`catalog` (optional string) The name of the catalog to fetch the schema from.
 
-`schemaPattern` (required string) A Java pattern of schemas to fetch.
+`schemaPattern` (optional string) A Java pattern of schemas to fetch.
 
 ### TableTypesRequest
 
@@ -945,6 +946,9 @@ specification. This value is analogous to the values 
defined in `java.sql.Connec
 
 `schema` (optional string) The name of the schema to include when fetching 
connection properties.
 
+`isDirty` (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.
+
 ### CursorFactory
 
 This object represents the information required to cast untyped objects into 
the necessary type for some results.
diff --git a/site/_docs/protobuf_reference.md b/site/_docs/protobuf_reference.md
index 327522e..f3a9475 100644
--- a/site/_docs/protobuf_reference.md
+++ b/site/_docs/protobuf_reference.md
@@ -957,7 +957,8 @@ message ConnectionProperties {
 }
 {% endhighlight %}
 
-`is_dirty` A boolean denoting if the properties have been altered.
+`is_dirty` 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.
 
 `auto_commit` A boolean denoting if autoCommit is enabled for transactions.