Author: elserj
Date: Thu Apr 21 16:34:31 2016
New Revision: 1740351
URL: http://svn.apache.org/viewvc?rev=1740351&view=rev
Log:
PHOENIX-2752 Addendum for PQS client options
Modified:
phoenix/site/publish/server.html
phoenix/site/source/src/site/markdown/server.md
Modified: phoenix/site/publish/server.html
URL:
http://svn.apache.org/viewvc/phoenix/site/publish/server.html?rev=1740351&r1=1740350&r2=1740351&view=diff
==============================================================================
--- phoenix/site/publish/server.html (original)
+++ phoenix/site/publish/server.html Thu Apr 21 16:34:31 2016
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2016-04-18
+ Generated by Apache Maven Doxia at 2016-04-21
Rendered using Reflow Maven Skin 1.1.0
(http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
@@ -62,12 +62,12 @@
<li ><a
href="issues.html" title="Issue Tracking">Issue Tracking</a></li>
<li ><a
href="download.html" title="Download">Download</a></li>
<li ><a
href="installation.html" title="Installation">Installation</a></li>
- <li ><a
href="http:divider" title=""></a></li>
+ <li
class="divider"/>
<li ><a
href="contributing.html" title="How to Contribute">How to Contribute</a></li>
<li ><a
href="develop.html" title="How to Develop">How to Develop</a></li>
<li ><a
href="building_website.html" title="How to Update Website">How to Update
Website</a></li>
<li ><a
href="release.html" title="How to Release">How to Release</a></li>
- <li ><a
href="http:divider" title=""></a></li>
+ <li
class="divider"/>
<li ><a
href="http://www.apache.org/licenses/"; title="License"
class="externalLink">License</a></li>
</ul>
</li>
@@ -81,29 +81,29 @@
<li ><a
href="upgrading.html" title="Backward Compatibility">Backward
Compatibility</a></li>
<li ><a
href="release_notes.html" title="Release Notes">Release Notes</a></li>
<li ><a
href="pherf.html" title="Performance Testing">Performance Testing</a></li>
- <li ><a
href="http:divider" title=""></a></li>
+ <li
class="divider"/>
<li ><a
href="phoenix_spark.html" title="Apache Spark Integration">Apache Spark
Integration</a></li>
<li ><a
href="pig_integration.html" title="Apache Pig Integration">Apache Pig
Integration</a></li>
<li ><a
href="phoenix_mr.html" title="Map Reduce Integration">Map Reduce
Integration</a></li>
<li ><a
href="flume.html" title="Apache Flume Plugin">Apache Flume Plugin</a></li>
</ul>
</li>
- <li class="dropdown
active">
+ <li class="dropdown">
<a href="#"
class="dropdown-toggle" data-toggle="dropdown">Features <b
class="caret"></b></a>
<ul
class="dropdown-menu">
<li ><a
href="transactions.html" title="Transactions">Transactions</a></li>
<li ><a
href="udf.html" title="User-defined Functions">User-defined Functions</a></li>
- <li ><a
href="http:divider" title=""></a></li>
+ <li
class="divider"/>
<li ><a
href="secondary_indexing.html" title="Secondary Indexes">Secondary
Indexes</a></li>
<li ><a
href="update_statistics.html" title="Statistics Collection">Statistics
Collection</a></li>
<li ><a
href="rowtimestamp.html" title="Row Timestamp Column">Row Timestamp
Column</a></li>
<li ><a
href="salted.html" title="Salted Tables">Salted Tables</a></li>
<li ><a
href="skip_scan.html" title="Skip Scan">Skip Scan</a></li>
- <li ><a
href="http:divider" title=""></a></li>
+ <li
class="divider"/>
<li ><a
href="views.html" title="Views">Views</a></li>
<li ><a
href="multi-tenancy.html" title="Multi tenancy">Multi tenancy</a></li>
<li ><a
href="dynamic_columns.html" title="Dynamic Columns">Dynamic Columns</a></li>
- <li ><a
href="http:divider" title=""></a></li>
+ <li
class="divider"/>
<li ><a
href="bulk_dataload.html" title="Bulk Loading">Bulk Loading</a></li>
<li
class="active"><a href="" title="Query Server">Query Server</a></li>
<li ><a
href="tracing.html" title="Tracing">Tracing</a></li>
@@ -117,7 +117,7 @@
<li ><a
href="language/functions.html" title="Functions">Functions</a></li>
<li ><a
href="language/datatypes.html" title="Datatypes">Datatypes</a></li>
<li ><a
href="array_type.html" title="ARRAY type">ARRAY type</a></li>
- <li ><a
href="http:divider" title=""></a></li>
+ <li
class="divider"/>
<li ><a
href="paged.html" title="Row Value Constructors">Row Value Constructors</a></li>
<li ><a
href="sequences.html" title="Sequences">Sequences</a></li>
<li ><a
href="joins.html" title="Joins">Joins</a></li>
@@ -175,12 +175,13 @@
<p>Phoenix provides two mechanisms for interacting with the query server. A
JDBC driver is provided in the standalone
<tt>phoenix-<version>-thin-client.jar</tt>. The script
<tt>bin/sqlline-thin.py</tt> is available for the command line.</p>
<p>The JDBC connection string is composed as follows:</p>
<div class="source">
-
<pre>jdbc:phoenix:thin:url=<scheme>://<server-hostname>:<port>
+
<pre>jdbc:phoenix:thin:url=<scheme>://<server-hostname>:<port>[...]
</pre>
</div>
<p><tt><scheme></tt> specifies the transport protocol used when
communicating with the server. The only supported transport at this time is
<tt>http</tt>.</p>
<p><tt><server-hostname></tt> is the name of the host offering the
service.</p>
<p><tt><port></tt> is the port number on which the host is listening.
Default is <tt>8765</tt>, though this is configurable (see below).</p>
+ <p>A full list of options that can be provided via the JDBC URL string is <a
href="#jdbc_url_options">available in the below table</a></p>
<p>The script <tt>bin/sqlline-thin.py</tt> is intended to behave identically
to its sibling script <tt>bin/sqlline.py</tt>. It supports the following usage
options.</p>
<div class="source">
<pre>bin/sqlline-thin.py [[scheme://]host[:port]] [sql_file]
@@ -312,34 +313,55 @@ log4j.logger.org.eclipse.jetty.server=IN
<td colspan="3"> </td>
</tr>
<tr class="a">
- <td colspan="3"><b>Configurations relating to the server statement
cache.</b></td>
+ <td colspan="3" id="jdbc_url_options"><b>JDBC URL options.</b></td>
+ </tr>
+ <tr class="b">
+ <td><small>url</small></td>
+ <td style="text-align: left;"> The URL of the QueryServer. </td>
+ <td>null</td>
+ </tr>
+ <tr class="a">
+ <td><small>serialization</small></td>
+ <td style="text-align: left;"> The client-side analogy to
phoenix.queryserver.serialization in the server to control how the client
should serialize data to send to the QueryServer. </td>
+ <td>PROTOBUF</td>
</tr>
<tr class="b">
+ <td><small>timeZone</small></td>
+ <td style="text-align: left;"> The time zone the JDBC connection should
use. If not provided, the time zone will be specified by JVM. The value of this
should be parseable by Java's TimeZone class. </td>
+ <td>null</td>
+ </tr>
+ <tr class="a">
+ <td colspan="3"> </td>
+ </tr>
+ <tr class="b">
+ <td colspan="3"><b>Configurations relating to the server statement
cache.</b></td>
+ </tr>
+ <tr class="a">
<td><b>Property</b></td>
<td><b>Description</b></td>
<td><b>Default</b></td>
</tr>
- <tr class="a">
+ <tr class="b">
<td><small>avatica.statementcache.concurrency</small></td>
<td style="text-align: left;">Statement cache concurrency level. Default
is 100.</td>
<td>100</td>
</tr>
- <tr class="b">
+ <tr class="a">
<td><small>avatica.statementcache.initialcapacity</small></td>
<td style="text-align: left;">Statement cache initial capacity. Default is
1000.</td>
<td>1000</td>
</tr>
- <tr class="a">
+ <tr class="b">
<td><small>avatica.statementcache.maxcapacity</small></td>
<td style="text-align: left;"> Statement cache maximum capacity.
Approaching this point, the cache will start to evict least recently used
statement objects. Default is 10000. </td>
<td>10000</td>
</tr>
- <tr class="b">
+ <tr class="a">
<td><small>avatica.statementcache.expiryduration</small></td>
<td style="text-align: left;"> Statement cache expiration duration. Any
statements older than this value will be discarded. Default is 5 minutes. </td>
<td>5</td>
</tr>
- <tr class="a">
+ <tr class="b">
<td><small>avatica.statementcache.expiryunit</small></td>
<td style="text-align: left;"> Statement cache expiration unit. Unit
modifier applied to the value provided in avatica.statementcache.expiryunit.
Default is minutes. </td>
<td>MINUTES</td>
Modified: phoenix/site/source/src/site/markdown/server.md
URL:
http://svn.apache.org/viewvc/phoenix/site/source/src/site/markdown/server.md?rev=1740351&r1=1740350&r2=1740351&view=diff
==============================================================================
--- phoenix/site/source/src/site/markdown/server.md (original)
+++ phoenix/site/source/src/site/markdown/server.md Thu Apr 21 16:34:31 2016
@@ -59,7 +59,7 @@ driver is provided in the standalone
The JDBC connection string is composed as follows:
- jdbc:phoenix:thin:url=<scheme>://<server-hostname>:<port>
+ jdbc:phoenix:thin:url=<scheme>://<server-hostname>:<port>[...]
`<scheme>` specifies the transport protocol used when communicating with the
server. The only supported transport at this time is `http`.
@@ -69,6 +69,9 @@ server. The only supported transport at
`<port>` is the port number on which the host is listening. Default is `8765`,
though this is configurable (see below).
+A full list of options that can be provided via the JDBC URL string is
[available
+in the below table](#jdbc_url_options)
+
The script `bin/sqlline-thin.py` is intended to behave identically to its
sibling script `bin/sqlline.py`. It supports the following usage options.
@@ -201,6 +204,34 @@ configuration.
</tr>
<tr><td colspan="3"> </td></tr>
<tr>
+ <td colspan="3" id="jdbc_url_options"><b>JDBC URL options.</b></td>
+ </tr>
+ <tr>
+ <td><small>url</small></td>
+ <td style="text-align: left;">
+ The URL of the QueryServer.
+ </td>
+ <td>null</td>
+ </tr>
+ <tr>
+ <td><small>serialization</small></td>
+ <td style="text-align: left;">
+ The client-side analogy to phoenix.queryserver.serialization in the
server
+ to control how the client should serialize data to send to the
QueryServer.
+ </td>
+ <td>PROTOBUF</td>
+ </tr>
+ <tr>
+ <td><small>timeZone</small></td>
+ <td style="text-align: left;">
+ The time zone the JDBC connection should use. If not provided, the
+ time zone will be specified by JVM. The value of this should be
parseable by
+ Java's TimeZone class.
+ </td>
+ <td>null</td>
+ </tr>
+ <tr><td colspan="3"> </td></tr>
+ <tr>
<td colspan="3"><b>Configurations relating to the server statement
cache.</b></td>
</tr>
<tr><td><b>Property</b></td><td><b>Description</b></td><td><b>Default</b></td></tr>
