Author: elserj
Date: Sun Apr 17 21:01:58 2016
New Revision: 1739657
URL: http://svn.apache.org/viewvc?rev=1739657&view=rev
Log:
[CALCITE-1201] [CALCITE-1192] Avatica doc updates
Modified:
calcite/site/avatica/docs/json_reference.html
calcite/site/avatica/docs/protobuf_reference.html
Modified: calcite/site/avatica/docs/json_reference.html
URL:
http://svn.apache.org/viewvc/calcite/site/avatica/docs/json_reference.html?rev=1739657&r1=1739656&r2=1739657&view=diff
==============================================================================
--- calcite/site/avatica/docs/json_reference.html (original)
+++ calcite/site/avatica/docs/json_reference.html Sun Apr 17 21:01:58 2016
@@ -569,7 +569,7 @@ which uniquely identifies the concrete R
<span class="nt">"request"</span><span class="p">:</span> <span
class="s2">"prepareAndExecuteBatch"</span><span class="p">,</span>
<span class="nt">"connectionId"</span><span class="p">:</span>
<span class="s2">"000000-0000-0000-00000000"</span><span
class="p">,</span>
<span class="nt">"statementId"</span><span class="p">:</span>
<span class="mi">12345</span><span class="p">,</span>
- <span class="nt">"sqlCommands"</span><span class="p">,</span>
<span class="err">[</span> <span class="nt">"SQL Command"</span><span
class="p">,</span> <span class="nt">"SQL Command"</span><span
class="p">,</span> <span class="err">...</span> <span class="err">]</span>
+ <span class="nt">"sqlCommands"</span><span class="p">:</span>
<span class="p">[</span> <span class="s2">"SQL Command"</span><span
class="p">,</span> <span class="s2">"SQL Command"</span><span
class="p">,</span> <span class="err">...</span> <span class="p">]</span>
<span class="p">}</span></code></pre></div>
<p><code>connectionId</code> (required string) The identifier for the
connection to use.</p>
@@ -1349,6 +1349,170 @@ SQL or by a DatabaseMetaData operation w
<p><code>value</code> A JSON representation of a JDBC type.</p>
+<p>The following chart documents how each <a href="#rep">Rep</a> value is
serialized
+into a JSON value. Consult the <a
href="http://json-spec.readthedocs.org/en/latest/reference.html";>JSON
documentation</a>
+for more information on valid attributes in JSON.</p>
+
+<table>
+ <tbody>
+ <tr>
+ <td><a href="#rep">Rep</a> Value</td>
+ <td>Serialized</td>
+ <td>Description</td>
+ </tr>
+ <tr>
+ <td>PRIMITIVE_BOOLEAN</td>
+ <td>boolean</td>
+ <td>Â </td>
+ </tr>
+ <tr>
+ <td>BOOLEAN</td>
+ <td>boolean</td>
+ <td>Â </td>
+ </tr>
+ <tr>
+ <td>PRIMITIVE_BYTE</td>
+ <td>number</td>
+ <td>The numeric value of the <code>byte</code>.</td>
+ </tr>
+ <tr>
+ <td>BYTE</td>
+ <td>number</td>
+ <td>Â </td>
+ </tr>
+ <tr>
+ <td>PRIMITIVE_CHAR</td>
+ <td>string</td>
+ <td>Â </td>
+ </tr>
+ <tr>
+ <td>CHARACTER</td>
+ <td>string</td>
+ <td>Â </td>
+ </tr>
+ <tr>
+ <td>PRIMITIVE_SHORT</td>
+ <td>number</td>
+ <td>Â </td>
+ </tr>
+ <tr>
+ <td>SHORT</td>
+ <td>number</td>
+ <td>Â </td>
+ </tr>
+ <tr>
+ <td>PRIMITIVE_INT</td>
+ <td>number</td>
+ <td>Â </td>
+ </tr>
+ <tr>
+ <td>INTEGER</td>
+ <td>number</td>
+ <td>Â </td>
+ </tr>
+ <tr>
+ <td>PRIMITIVE_LONG</td>
+ <td>number</td>
+ <td>Â </td>
+ </tr>
+ <tr>
+ <td>LONG</td>
+ <td>number</td>
+ <td>Â </td>
+ </tr>
+ <tr>
+ <td>PRIMITIVE_FLOAT</td>
+ <td>number</td>
+ <td>Â </td>
+ </tr>
+ <tr>
+ <td>FLOAT</td>
+ <td>number</td>
+ <td>Â </td>
+ </tr>
+ <tr>
+ <td>PRIMITIVE_DOUBLE</td>
+ <td>number</td>
+ <td>Â </td>
+ </tr>
+ <tr>
+ <td>DOUBLE</td>
+ <td>number</td>
+ <td>Â </td>
+ </tr>
+ <tr>
+ <td>BIG_INTEGER</td>
+ <td>number</td>
+ <td>Implicitly handled by Jackson.</td>
+ </tr>
+ <tr>
+ <td>BIG_DECIMAL</td>
+ <td>number</td>
+ <td>Implicitly handled by Jackson.</td>
+ </tr>
+ <tr>
+ <td>JAVA_SQL_TIME</td>
+ <td>number</td>
+ <td>As an integer, millis since midnight.</td>
+ </tr>
+ <tr>
+ <td>JAVA_SQL_DATE</td>
+ <td>number</td>
+ <td>As an integer, days since the epoch.</td>
+ </tr>
+ <tr>
+ <td>JAVA_SQL_TIMESTAMP</td>
+ <td>number</td>
+ <td>As a long, millis since the epoch.</td>
+ </tr>
+ <tr>
+ <td>JAVA_UTIL_DATE</td>
+ <td>number</td>
+ <td>As a long, millis since the epoch.</td>
+ </tr>
+ <tr>
+ <td>BYTE_STRING</td>
+ <td>string</td>
+ <td>A Base64-encoded string.</td>
+ </tr>
+ <tr>
+ <td>STRING</td>
+ <td>string</td>
+ <td>Â </td>
+ </tr>
+ <tr>
+ <td>NUMBER</td>
+ <td>number</td>
+ <td>A general number, unknown what concrete type.</td>
+ </tr>
+ <tr>
+ <td>OBJECT</td>
+ <td>null</td>
+ <td>Implicitly converted by Jackson.</td>
+ </tr>
+ <tr>
+ <td>NULL</td>
+ <td>null</td>
+ <td>Implicitly converted by Jackson.</td>
+ </tr>
+ <tr>
+ <td>ARRAY</td>
+ <td>N/A</td>
+ <td>Implicitly handled by Jackson.</td>
+ </tr>
+ <tr>
+ <td>STRUCT</td>
+ <td>N/A</td>
+ <td>Implicitly handled by Jackson.</td>
+ </tr>
+ <tr>
+ <td>MULTISET</td>
+ <td>N/A</td>
+ <td>Implicitly handled by Jackson.</td>
+ </tr>
+ </tbody>
+</table>
+
Modified: calcite/site/avatica/docs/protobuf_reference.html
URL:
http://svn.apache.org/viewvc/calcite/site/avatica/docs/protobuf_reference.html?rev=1739657&r1=1739656&r2=1739657&view=diff
==============================================================================
--- calcite/site/avatica/docs/protobuf_reference.html (original)
+++ calcite/site/avatica/docs/protobuf_reference.html Sun Apr 17 21:01:58 2016
@@ -1392,6 +1392,169 @@ SQL or by a DatabaseMetaData operation w
<p><code>null</code> A boolean which denotes if the value was null.</p>
+<p>The following chart documents how each <a href="#rep">Rep</a> value
corresponds
+to the attributes in this message:</p>
+
+<table>
+ <tbody>
+ <tr>
+ <td><a href="#rep">Rep</a> Value</td>
+ <td><a href="#typedvalue">TypedValue</a> attribute</td>
+ <td>Description</td>
+ </tr>
+ <tr>
+ <td>PRIMITIVE_BOOLEAN</td>
+ <td><code>bool_value</code></td>
+ <td>Â </td>
+ </tr>
+ <tr>
+ <td>BOOLEAN</td>
+ <td><code>bool_value</code></td>
+ <td>Â </td>
+ </tr>
+ <tr>
+ <td>PRIMITIVE_BYTE</td>
+ <td><code>number_value</code></td>
+ <td>The numeric value of the <code>byte</code>.</td>
+ </tr>
+ <tr>
+ <td>BYTE</td>
+ <td><code>number_value</code></td>
+ <td>Â </td>
+ </tr>
+ <tr>
+ <td>PRIMITIVE_CHAR</td>
+ <td><code>string_value</code></td>
+ <td>Â </td>
+ </tr>
+ <tr>
+ <td>CHARACTER</td>
+ <td><code>string_value</code></td>
+ <td>Â </td>
+ </tr>
+ <tr>
+ <td>PRIMITIVE_SHORT</td>
+ <td><code>number_value</code></td>
+ <td>Â </td>
+ </tr>
+ <tr>
+ <td>SHORT</td>
+ <td><code>number_value</code></td>
+ <td>Â </td>
+ </tr>
+ <tr>
+ <td>PRIMITIVE_INT</td>
+ <td><code>number_value</code></td>
+ <td>Â </td>
+ </tr>
+ <tr>
+ <td>INTEGER</td>
+ <td><code>number_value</code></td>
+ <td>Â </td>
+ </tr>
+ <tr>
+ <td>PRIMITIVE_LONG</td>
+ <td><code>number_value</code></td>
+ <td>Â </td>
+ </tr>
+ <tr>
+ <td>LONG</td>
+ <td><code>number_value</code></td>
+ <td>Â </td>
+ </tr>
+ <tr>
+ <td>PRIMITIVE_FLOAT</td>
+ <td><code>number_value</code></td>
+ <td>Â </td>
+ </tr>
+ <tr>
+ <td>FLOAT</td>
+ <td><code>number_value</code></td>
+ <td>IEEE 754 floating-point âsingle formatâ bit layout.</td>
+ </tr>
+ <tr>
+ <td>PRIMITIVE_DOUBLE</td>
+ <td><code>number_value</code></td>
+ <td>Â </td>
+ </tr>
+ <tr>
+ <td>DOUBLE</td>
+ <td><code>number_value</code></td>
+ <td>Â </td>
+ </tr>
+ <tr>
+ <td>BIG_INTEGER</td>
+ <td><code>bytes_value</code></td>
+ <td>The twoâs-complement representation of the BigInteger. See
<code>BigInteger#toByteArray().</code></td>
+ </tr>
+ <tr>
+ <td>BIG_DECIMAL</td>
+ <td><code>string_value</code></td>
+ <td>A string-ified representation of the value. See
<code>BigDecimal#toString()</code>.</td>
+ </tr>
+ <tr>
+ <td>JAVA_SQL_TIME</td>
+ <td><code>number_value</code></td>
+ <td>Â </td>
+ </tr>
+ <tr>
+ <td>JAVA_SQL_DATE</td>
+ <td><code>number_value</code></td>
+ <td>Â </td>
+ </tr>
+ <tr>
+ <td>JAVA_SQL_TIMESTAMP</td>
+ <td><code>number_value</code></td>
+ <td>Â </td>
+ </tr>
+ <tr>
+ <td>JAVA_UTIL_DATE</td>
+ <td><code>number_value</code></td>
+ <td>Â </td>
+ </tr>
+ <tr>
+ <td>BYTE_STRING</td>
+ <td><code>bytes_value</code></td>
+ <td>Â </td>
+ </tr>
+ <tr>
+ <td>STRING</td>
+ <td><code>string_value</code></td>
+ <td>This must be a UTF-8 string.</td>
+ </tr>
+ <tr>
+ <td>NUMBER</td>
+ <td><code>number_value</code></td>
+ <td>A general number, unknown what concrete type.</td>
+ </tr>
+ <tr>
+ <td>OBJECT</td>
+ <td><code>null</code></td>
+ <td>The only general Object we can serialize is ânullâ. Non-null
OBJECTâs will throw an error.</td>
+ </tr>
+ <tr>
+ <td>NULL</td>
+ <td><code>null</code></td>
+ <td>Â </td>
+ </tr>
+ <tr>
+ <td>ARRAY</td>
+ <td>N/A</td>
+ <td>Unhandled.</td>
+ </tr>
+ <tr>
+ <td>STRUCT</td>
+ <td>N/A</td>
+ <td>Unhandled.</td>
+ </tr>
+ <tr>
+ <td>MULTISET</td>
+ <td>N/A</td>
+ <td>Unhandled.</td>
+ </tr>
+ </tbody>
+</table>
+
<h3 id="updatebatch">UpdateBatch</h3>
<p>This is a message which serves as a wrapper around a collection of <a
href="#typedvalue">TypedValue</a>âs.</p>
