You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@phoenix.apache.org by ja...@apache.org on 2016/03/09 05:54:21 UTC
svn commit: r1734189 - in /phoenix/site: publish/ source/src/site/markdown/
Author: jamestaylor
Date: Wed Mar 9 04:54:20 2016
New Revision: 1734189
URL: http://svn.apache.org/viewvc?rev=1734189&view=rev
Log:
Updates to docs for 4.7 release
Modified:
phoenix/site/publish/Phoenix-in-15-minutes-or-less.html
phoenix/site/publish/download.html
phoenix/site/publish/recent.html
phoenix/site/publish/server.html
phoenix/site/publish/transactions.html
phoenix/site/source/src/site/markdown/Phoenix-in-15-minutes-or-less.md
phoenix/site/source/src/site/markdown/download.md
phoenix/site/source/src/site/markdown/recent.md
phoenix/site/source/src/site/markdown/server.md
phoenix/site/source/src/site/markdown/transactions.md
Modified: phoenix/site/publish/Phoenix-in-15-minutes-or-less.html
URL: http://svn.apache.org/viewvc/phoenix/site/publish/Phoenix-in-15-minutes-or-less.html?rev=1734189&r1=1734188&r2=1734189&view=diff
==============================================================================
--- phoenix/site/publish/Phoenix-in-15-minutes-or-less.html (original)
+++ phoenix/site/publish/Phoenix-in-15-minutes-or-less.html Wed Mar 9 04:54:20 2016
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2016-03-04
+ Generated by Apache Maven Doxia at 2016-03-08
Rendered using Reflow Maven Skin 1.1.0 (http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
@@ -222,8 +222,7 @@ ORDER BY sum(population) DESC;
</div>
<p>Congratulations! Youâve just created your first Phoenix table, inserted data into it, and executed an aggregate query with just a few lines of code in 15 minutes or less! </p>
<p><i><b>Big deal - 10 rows! What else you got?</b></i><br /> Ok, ok - tough crowd. Check out our <tt>bin/performance.py</tt> script to create as many rows as you want, for any schema you come up with, and run timed queries against it.</p>
-<p><i><b>Why is it called Phoenix anyway? Did some other project crash and burn and this is the next generation?</b></i><br /> Iâm sorry, but weâre out of time and space, so weâll have to answer that next time!</p>
-<p>Thanks for your time,<br /> James Taylor<br /> <a class="externalLink" href="http://phoenix-hbase.blogspot.com/">http://phoenix-hbase.blogspot.com/</a> <br /> @JamesPlusPlus<br /></p>
+<p><i><b>Why is it called Phoenix anyway? Did some other project crash and burn and this is the next generation?</b></i><br /> Iâm sorry, but weâre out of time and space, so weâll have to answer that next time!</p>
</div>
</div>
</div>
Modified: phoenix/site/publish/download.html
URL: http://svn.apache.org/viewvc/phoenix/site/publish/download.html?rev=1734189&r1=1734188&r2=1734189&view=diff
==============================================================================
--- phoenix/site/publish/download.html (original)
+++ phoenix/site/publish/download.html Wed Mar 9 04:54:20 2016
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2016-03-04
+ Generated by Apache Maven Doxia at 2016-03-08
Rendered using Reflow Maven Skin 1.1.0 (http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
@@ -146,24 +146,7 @@
<div class="section">
<div class="section">
<h3 id="Download_Latest_Phoenix_Binary_and_Source_Releases"><a class="externalLink" href="http://www.apache.org/dyn/closer.lua/phoenix/"><u>Download Latest Phoenix Binary and Source Releases</u></a></h3>
- </div>
- <div class="section">
- <h3 id="See_Latest_Release_Notes"><a href="release_notes.html"><u>See Latest Release Notes</u></a></h3>
- <div class="section">
- <h4 id="List_of_New_Features"><a href="recent.html">List of New Features</a></h4>
- </div>
- </div>
- <div class="section">
- <h3 id="HBase_Compatibility">HBase Compatibility</h3>
- <ul>
- <li>Phoenix 2.x - HBase 0.94.x</li>
- <li>Phoenix 3.x - HBase 0.94.x</li>
- <li> <p>Phoenix 4.x - HBase 0.98.1+ </p>
- <hr /><p></p>
- <div class="section">
- <h4 id="See_also:_Installation_Instructions">See also: <a href="installation.html">Installation Instructions</a></h4>
- </div></li>
- </ul>
+ <p>See our installation instructions <a href="installation.html">here</a>, our release notes <a href="release_notes.html">here</a>, and a list of new features <a href="recent.html">here</a></p>
</div>
</div>
</div>
Modified: phoenix/site/publish/recent.html
URL: http://svn.apache.org/viewvc/phoenix/site/publish/recent.html?rev=1734189&r1=1734188&r2=1734189&view=diff
==============================================================================
--- phoenix/site/publish/recent.html (original)
+++ phoenix/site/publish/recent.html Wed Mar 9 04:54:20 2016
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2016-03-04
+ Generated by Apache Maven Doxia at 2016-03-08
Rendered using Reflow Maven Skin 1.1.0 (http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
@@ -145,7 +145,8 @@
</div>
<p>As items are implemented from our road map, they are moved here to track the progress weâve made:</p>
<ol style="list-style-type: decimal">
- <li><b><a class="externalLink" href="https://issues.apache.org/jira/browse/PHOENIX-1674">Transaction Support</a></b>. Supports transactions by integrating with <a class="externalLink" href="https://github.com/continuuity/tephra">Tephra</a>. <b>Available in our 4.7 release</b></li>
+ <li><b><a href="transactions.html">Transaction Support</a></b>. Supports transactions by integrating with <a class="externalLink" href="https://github.com/continuuity/tephra">Tephra</a>. <b>Available in our 4.7 release</b></li>
+ <li><b><a href="rowtimestamp.html">Time series Optimization</a></b>. Optimizes queries against time series data as explained in more detail <a class="externalLink" href="https://blogs.apache.org/phoenix/entry/new_optimization_for_time_series">here</a>. <b>Available in our 4.6 release</b></li>
<li><b><a href="secondary_indexing.html#Asynchronous_Index_Population">Asynchronous Index Population</a></b>. Enables an index to be created asynchronously using a map reduce job. <b>Available in our 4.5 release</b></li>
<li><b><a href="udf.html">User Defined Functions</a></b>. Allows users to create and deploy their own custom or domain-specific user-defined functions to the cluster. <b>Available in our 4.4 release</b></li>
<li><b><a href="secondary_indexing.html#Functional_Indexes">Functional Indexes</a></b>. Enables an index to be defined as expressions as opposed to just column names and have the index be used when a query contains this expression. <b>Available in our 4.3 release</b></li>
Modified: phoenix/site/publish/server.html
URL: http://svn.apache.org/viewvc/phoenix/site/publish/server.html?rev=1734189&r1=1734188&r2=1734189&view=diff
==============================================================================
--- phoenix/site/publish/server.html (original)
+++ phoenix/site/publish/server.html Wed Mar 9 04:54:20 2016
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2016-03-04
+ Generated by Apache Maven Doxia at 2016-03-08
Rendered using Reflow Maven Skin 1.1.0 (http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
@@ -146,9 +146,9 @@
<p>The Phoenix Query Server provides an alternative means for interaction with Phoenix and HBase. Soon this will enable access from environments other than the JVM.</p>
<div class="section">
<h2 id="Overview">Overview</h2>
- <p>Phoenix 4.4 introduces a stand-alone server that exposes Phoenix to âthinâ clients. It is based on the <a class="externalLink" href="https://github.com/apache/incubator-calcite/blob/master/doc/avatica.md">Avatica</a> component of <a class="externalLink" href="http://calcite.incubator.apache.org/">Apache Calcite</a>. The query server is comprised of a Java server that manages Phoenix Connections on the clientsâ behalf. The client implementation is currently a JDBC driver with minimal dependencies. The transport mechanism is currently JSON encoded requests over HTTP transport. Thereâs also a sqlline script that uses the thin client.</p>
- <p>Avatica is relatively early in its life-cycle. The RPC API has not yet solidified, so <b><i>there is no promise of backward compatibility at this time</i></b>. Future versions of Avatica should include additional encoding and transport mechanisms. Client implementations for non-Java languages are anticipated as well.</p>
- <p>To repeat, <big><b><i>there is no promise of backward compatibility at this time</i></b></big>.</p>
+ <p>Phoenix 4.4 introduces a stand-alone server that exposes Phoenix to âthinâ clients. It is based on the <a class="externalLink" href="https://calcite.apache.org/avatica">Avatica</a> component of <a class="externalLink" href="https://calcite.apache.org">Apache Calcite</a>. The query server is comprised of a Java server that manages Phoenix Connections on the clientsâ behalf. The client implementation is currently a JDBC driver with minimal dependencies. Two transport mechanisms are current supported: JSON and Protocol Buffers (available as of Phoenix 4.7 as the default). Thereâs also a sqlline script that uses the thin client.</p>
+ <p>Avatica is still relatively early in its life-cycle. With the introduction of the Protobuf transport, Avatica is moving towards backwards compatibility with the provided thin JDBC driver. There are no such backwards compatibility guarantees for the JSON API.</p>
+ <p>To repeat, there is no guarantee of backwards compatibility with the JSON transport; however, compatibility with the Protobuf transport is stabilizing (although, not tested thoroughly enough to be stated as âguaranteedâ).</p>
</div>
<div class="section">
<h2 id="Installation">Installation</h2>
@@ -170,7 +170,7 @@
</div>
<div class="section">
<h3 id="Client">Client</h3>
- <p>Phoenix provides two mechanisms for interacting with the query server. A JDBC driver is provided in the standalone <tt>phoenix-<version>-query-server-thin-client.jar</tt>. Its connection The script <tt>bin/sqlline-thin.py</tt> is available for the command line.</p>
+ <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>
@@ -185,10 +185,21 @@
</pre>
</div>
<p>The first optional argument is a connection URL, as described previously. When not provided, <tt>scheme</tt> defaults to <tt>http</tt>, <tt>host</tt> to <tt>localhost</tt>, and <tt>port</tt> to <tt>8765</tt>.</p>
+ <div class="source">
+ <pre>bin/sqlline-thin.py http://localhost:8765
+</pre>
+ </div>
<p>The second optional parameter is a sql file from which to read commands.</p>
</div>
</div>
<div class="section">
+ <h2 id="Wire_API_documentation">Wire API documentation</h2>
+ <p>The API itself is documented in the Apache Calcite project as it is the Avatica API â there is no wire API defined in Phoenix itself.</p>
+ <p><a class="externalLink" href="http://calcite.apache.org/avatica/docs/json_reference.html">JSON API</a></p>
+ <p><a class="externalLink" href="http://calcite.apache.org/avatica/docs/protobuf_reference.html">Protocol Buffer API</a></p>
+ <p>For more information in building clients in other languages that work with Avatica, please feel free to reach out to the <a class="externalLink" href="mailto:dev@calcite.apache.org">Apache Calcite dev mailing list</a>.</p>
+</div>
+<div class="section">
<h2 id="Configuration">Configuration</h2>
<p>Server components are spread across a number of java packages, so effective logging configuration requires updating multiple packages. The default server logging configuration sets the following log levels:</p>
<div class="source">
@@ -219,109 +230,114 @@ log4j.logger.org.eclipse.jetty.server=IN
<td>org.apache.phoenix.queryserver.server.PhoenixMetaFactoryImpl</td>
</tr>
<tr class="a">
- <td colspan="3"> </td>
+ <td><small>phoenix.queryserver.serialization</small></td>
+ <td style="text-align: left;">The transport/serialization format, either PROTOBUF or JSON.</td>
+ <td>PROTOBUF</td>
</tr>
<tr class="b">
- <td colspan="3"><b>Configurations relating to server connecting to a secure cluster.</b></td>
+ <td colspan="3"> </td>
</tr>
<tr class="a">
+ <td colspan="3"><b>Configurations relating to server connecting to a secure cluster.</b></td>
+ </tr>
+ <tr class="b">
<td><b>Property</b></td>
<td><b>Description</b></td>
<td><b>Default</b></td>
</tr>
- <tr class="b">
+ <tr class="a">
<td><small>hbase.security.authentication</small></td>
<td style="text-align: left;">When set to "kerberos", the server will attempt to log in before initiating Phoenix connections.</td>
<td><i>Specified hbase-default.xml</i></td>
</tr>
- <tr class="a">
+ <tr class="b">
<td><small>phoenix.queryserver.keytab.file</small></td>
<td style="text-align: left;">The key to look for keytab file.</td>
<td><i>unset</i></td>
</tr>
- <tr class="b">
+ <tr class="a">
<td><small>phoenix.queryserver.kerberos.principal</small></td>
<td style="text-align: left;">The kerberos principal to use when authenticating.</td>
<td><i>unset</i></td>
</tr>
- <tr class="a">
+ <tr class="b">
<td><small>phoenix.queryserver.dns.nameserver</small></td>
<td style="text-align: left;">The DNS hostname</td>
<td>default</td>
</tr>
- <tr class="b">
+ <tr class="a">
<td><small>phoenix.queryserver.dns.interface</small></td>
<td style="text-align: left;">The name of the network interface to query for DNS.</td>
<td>default</td>
</tr>
- <tr class="a">
+ <tr class="b">
<td colspan="3"> </td>
</tr>
- <tr class="b">
+ <tr class="a">
<td colspan="3"><b>Configurations relating to the server connection cache.</b></td>
</tr>
- <tr class="a">
+ <tr class="b">
<td><b>Property</b></td>
<td><b>Description</b></td>
<td><b>Default</b></td>
</tr>
- <tr class="b">
+ <tr class="a">
<td><small>avatica.connectioncache.concurrency</small></td>
<td style="text-align: left;">Connection cache concurrency level. Default is 10.</td>
<td>10</td>
</tr>
- <tr class="a">
+ <tr class="b">
<td><small>avatica.connectioncache.initialcapacity</small></td>
<td style="text-align: left;">Connection cache initial capacity. Default is 100.</td>
<td>100</td>
</tr>
- <tr class="b">
+ <tr class="a">
<td><small>avatica.connectioncache.maxcapacity</small></td>
<td style="text-align: left;"> Connection cache maximum capacity. Approaching this point, the cache will start to evict least recently used connection objects. Default is 1000. </td>
<td>1000</td>
</tr>
- <tr class="a">
+ <tr class="b">
<td><small>avatica.connectioncache.expiryduration</small></td>
<td style="text-align: left;"> Connection cache expiration duration. Any connections older than this value will be discarded. Default is 10 minutes. </td>
<td>10</td>
</tr>
- <tr class="b">
+ <tr class="a">
<td><small>avatica.connectioncache.expiryunit</small></td>
<td style="text-align: left;"> Connection cache expiration unit. Unit modifier applied to the value provided in avatica.connectioncache.expiryunit. Default is minutes. </td>
<td>MINUTES</td>
</tr>
- <tr class="a">
+ <tr class="b">
<td colspan="3"> </td>
</tr>
- <tr class="b">
+ <tr class="a">
<td colspan="3"><b>Configurations relating to the server statement cache.</b></td>
</tr>
- <tr class="a">
+ <tr class="b">
<td><b>Property</b></td>
<td><b>Description</b></td>
<td><b>Default</b></td>
</tr>
- <tr class="b">
+ <tr class="a">
<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="a">
+ <tr class="b">
<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="b">
+ <tr class="a">
<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="a">
+ <tr class="b">
<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="b">
+ <tr class="a">
<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/publish/transactions.html
URL: http://svn.apache.org/viewvc/phoenix/site/publish/transactions.html?rev=1734189&r1=1734188&r2=1734189&view=diff
==============================================================================
--- phoenix/site/publish/transactions.html (original)
+++ phoenix/site/publish/transactions.html Wed Mar 9 04:54:20 2016
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2016-03-04
+ Generated by Apache Maven Doxia at 2016-03-08
Rendered using Reflow Maven Skin 1.1.0 (http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
@@ -143,7 +143,7 @@
<div class="page-header">
<h1>Transactions (beta)</h1>
</div>
-<p>Above and beyond the row-level transactional semantics of HBase, Phoenix adds cross row and cross table transaction support with full <a class="externalLink" href="https://en.wikipedia.org/wiki/ACID">ACID</a> semantics by integrating with a transaction library named <a class="externalLink" href="http://tephra.io/">Tephra</a>. Tephra provides snapshot isolation of concurrent transactions by implementing multi-versioned concurrency control.</p>
+<p>Above and beyond the row-level transactional semantics of HBase, Phoenix adds cross row and cross table transaction support with full <a class="externalLink" href="https://en.wikipedia.org/wiki/ACID">ACID</a> semantics by integrating with <a class="externalLink" href="http://tephra.io/">Tephra</a>, now an Apache incubator project. Tephra provides snapshot isolation of concurrent transactions by implementing multi-versioned concurrency control.</p>
<p>Setting up a system to use transactions in Phoenix requires two steps:</p>
<ol style="list-style-type: decimal">
<li> <p>Add the following config to your client side <tt>hbase-site.xml</tt> file to enable transactions:</p>
Modified: phoenix/site/source/src/site/markdown/Phoenix-in-15-minutes-or-less.md
URL: http://svn.apache.org/viewvc/phoenix/site/source/src/site/markdown/Phoenix-in-15-minutes-or-less.md?rev=1734189&r1=1734188&r2=1734189&view=diff
==============================================================================
--- phoenix/site/source/src/site/markdown/Phoenix-in-15-minutes-or-less.md (original)
+++ phoenix/site/source/src/site/markdown/Phoenix-in-15-minutes-or-less.md Wed Mar 9 04:54:20 2016
@@ -89,8 +89,3 @@ Ok, ok - tough crowd. Check out our <cod
*<strong>Why is it called Phoenix anyway? Did some other project crash and burn and this is the next generation?</strong>*<br/>
I'm sorry, but we're out of time and space, so we'll have to answer that next time!
-Thanks for your time,<br/>
-James Taylor<br/>
-http://phoenix-hbase.blogspot.com/
-<br/>
-@JamesPlusPlus<br/>
Modified: phoenix/site/source/src/site/markdown/download.md
URL: http://svn.apache.org/viewvc/phoenix/site/source/src/site/markdown/download.md?rev=1734189&r1=1734188&r2=1734189&view=diff
==============================================================================
--- phoenix/site/source/src/site/markdown/download.md (original)
+++ phoenix/site/source/src/site/markdown/download.md Wed Mar 9 04:54:20 2016
@@ -2,13 +2,5 @@
### [<u>Download Latest Phoenix Binary and Source Releases</u>](http://www.apache.org/dyn/closer.lua/phoenix/)
-### [<u>See Latest Release Notes</u>](release_notes.html)
-
-#### [List of New Features](recent.html)
-
-### HBase Compatibility
-* Phoenix 2.x - HBase 0.94.x
-* Phoenix 3.x - HBase 0.94.x
-* Phoenix 4.x - HBase 0.98.1+
-<hr/>
-#### See also: [Installation Instructions](installation.html)
+See our installation instructions [here](installation.html), our release notes [here](release_notes.html),
+and a list of new features [here](recent.html)
Modified: phoenix/site/source/src/site/markdown/recent.md
URL: http://svn.apache.org/viewvc/phoenix/site/source/src/site/markdown/recent.md?rev=1734189&r1=1734188&r2=1734189&view=diff
==============================================================================
--- phoenix/site/source/src/site/markdown/recent.md (original)
+++ phoenix/site/source/src/site/markdown/recent.md Wed Mar 9 04:54:20 2016
@@ -2,7 +2,8 @@
As items are implemented from our road map, they are moved here to track the progress we've made:
-1. **[Transaction Support](https://issues.apache.org/jira/browse/PHOENIX-1674)**. Supports transactions by integrating with [Tephra](https://github.com/continuuity/tephra). **Available in our 4.7 release**
+1. **[Transaction Support](transactions.html)**. Supports transactions by integrating with [Tephra](https://github.com/continuuity/tephra). **Available in our 4.7 release**
+1. **[Time series Optimization](rowtimestamp.html)**. Optimizes queries against time series data as explained in more detail [here](https://blogs.apache.org/phoenix/entry/new_optimization_for_time_series). **Available in our 4.6 release**
1. **[Asynchronous Index Population](secondary_indexing.html#Asynchronous_Index_Population)**. Enables an index to be created asynchronously using a map reduce job. **Available in our 4.5 release**
2. **[User Defined Functions](udf.html)**. Allows users to create and deploy their own custom or domain-specific user-defined functions to the cluster. **Available in our 4.4 release**
1. **[Functional Indexes](secondary_indexing.html#Functional_Indexes)**. Enables an index to be defined as expressions as opposed to just column names and have the index be used when a query contains this expression. **Available in our 4.3 release**
Modified: phoenix/site/source/src/site/markdown/server.md
URL: http://svn.apache.org/viewvc/phoenix/site/source/src/site/markdown/server.md?rev=1734189&r1=1734188&r2=1734189&view=diff
==============================================================================
--- phoenix/site/source/src/site/markdown/server.md (original)
+++ phoenix/site/source/src/site/markdown/server.md Wed Mar 9 04:54:20 2016
@@ -7,21 +7,21 @@ the JVM.
## Overview
Phoenix 4.4 introduces a stand-alone server that exposes Phoenix to "thin"
-clients. It is based on the [Avatica][avatica] component of
-[Apache Calcite][calcite]. The query server is comprised of a Java server that
+clients. It is based on the [Avatica](https://calcite.apache.org/avatica) component of
+[Apache Calcite](https://calcite.apache.org). The query server is comprised of a Java server that
manages Phoenix Connections on the clients' behalf. The client implementation
-is currently a JDBC driver with minimal dependencies. The transport mechanism
-is currently JSON encoded requests over HTTP transport. There's also a sqlline
-script that uses the thin client.
-
-Avatica is relatively early in its life-cycle. The RPC API has not yet
-solidified, so <b><em>there is no promise of backward compatibility at this
-time</em></b>. Future versions of Avatica should include additional encoding
-and transport mechanisms. Client implementations for non-Java languages are
-anticipated as well.
-
-To repeat, <big><b><em>there is no promise of backward compatibility at this
-time</em></b></big>.
+is currently a JDBC driver with minimal dependencies. Two transport mechanisms
+are current supported: JSON and Protocol Buffers (available as of Phoenix 4.7
+as the default). There's also a sqlline script that uses the thin client.
+
+Avatica is still relatively early in its life-cycle. With the introduction of the
+Protobuf transport, Avatica is moving towards backwards compatibility with the
+provided thin JDBC driver. There are no such backwards compatibility guarantees
+for the JSON API.
+
+To repeat, there is no guarantee of backwards compatibility with the JSON transport;
+however, compatibility with the Protobuf transport is stabilizing (although, not
+tested thoroughly enough to be stated as "guaranteed").
## Installation
@@ -54,7 +54,7 @@ classpath are all that is required to la
Phoenix provides two mechanisms for interacting with the query server. A JDBC
driver is provided in the standalone
-`phoenix-<version>-query-server-thin-client.jar`. Its connection The script
+`phoenix-<version>-thin-client.jar`. The script
`bin/sqlline-thin.py` is available for the command line.
The JDBC connection string is composed as follows:
@@ -78,8 +78,22 @@ The first optional argument is a connect
not provided, `scheme` defaults to `http`, `host` to `localhost`, and `port` to
`8765`.
+ bin/sqlline-thin.py http://localhost:8765
+
The second optional parameter is a sql file from which to read commands.
+## Wire API documentation
+
+The API itself is documented in the Apache Calcite project as it is the Avatica
+API -- there is no wire API defined in Phoenix itself.
+
+[JSON API](http://calcite.apache.org/avatica/docs/json_reference.html)
+
+[Protocol Buffer API](http://calcite.apache.org/avatica/docs/protobuf_reference.html)
+
+For more information in building clients in other languages that work with
+Avatica, please feel free to reach out to the [Apache Calcite dev mailing list](mailto:dev@calcite.apache.org).
+
## Configuration
Server components are spread across a number of java packages, so effective
@@ -110,6 +124,11 @@ configuration.
<td style="text-align: left;">The Avatica Meta.Factory class to instantiate.</td>
<td>org.apache.phoenix.queryserver.server.PhoenixMetaFactoryImpl</td>
</tr>
+ <tr>
+ <td><small>phoenix.queryserver.serialization</small></td>
+ <td style="text-align: left;">The transport/serialization format, either PROTOBUF or JSON.</td>
+ <td>PROTOBUF</td>
+ </tr>
<tr><td colspan="3"> </td></tr>
<tr>
<td colspan="3"><b>Configurations relating to server connecting to a secure cluster.</b></td>
@@ -222,7 +241,3 @@ configuration.
</tr>
</tbody>
</table>
-
-[avatica]: https://github.com/apache/incubator-calcite/blob/master/doc/avatica.md
-[calcite]: http://calcite.incubator.apache.org/
-
Modified: phoenix/site/source/src/site/markdown/transactions.md
URL: http://svn.apache.org/viewvc/phoenix/site/source/src/site/markdown/transactions.md?rev=1734189&r1=1734188&r2=1734189&view=diff
==============================================================================
--- phoenix/site/source/src/site/markdown/transactions.md (original)
+++ phoenix/site/source/src/site/markdown/transactions.md Wed Mar 9 04:54:20 2016
@@ -1,5 +1,5 @@
# Transactions (beta)
-Above and beyond the row-level transactional semantics of HBase, Phoenix adds cross row and cross table transaction support with full [ACID](https://en.wikipedia.org/wiki/ACID) semantics by integrating with a transaction library named [Tephra](http://tephra.io/). Tephra provides snapshot isolation of concurrent transactions by implementing multi-versioned concurrency control.
+Above and beyond the row-level transactional semantics of HBase, Phoenix adds cross row and cross table transaction support with full [ACID](https://en.wikipedia.org/wiki/ACID) semantics by integrating with [Tephra](http://tephra.io/), now an Apache incubator project. Tephra provides snapshot isolation of concurrent transactions by implementing multi-versioned concurrency control.
Setting up a system to use transactions in Phoenix requires two steps: