Author: elserj
Date: Fri Oct 18 15:06:28 2019
New Revision: 1868598
URL: http://svn.apache.org/viewvc?rev=1868598&view=rev
Log:
PHOENIX-5511 Update secondary indexing configurations by version (Istvan Toth)
Modified:
phoenix/site/publish/language/datatypes.html
phoenix/site/publish/language/functions.html
phoenix/site/publish/language/index.html
phoenix/site/publish/secondary_indexing.html
phoenix/site/source/src/site/markdown/secondary_indexing.md
Modified: phoenix/site/publish/language/datatypes.html
URL:
http://svn.apache.org/viewvc/phoenix/site/publish/language/datatypes.html?rev=1868598&r1=1868597&r2=1868598&view=diff
==============================================================================
--- phoenix/site/publish/language/datatypes.html (original)
+++ phoenix/site/publish/language/datatypes.html Fri Oct 18 15:06:28 2019
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2019-10-16
+ Generated by Apache Maven Doxia at 2019-10-18
Rendered using Reflow Maven Skin 1.1.0
(http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
Modified: phoenix/site/publish/language/functions.html
URL:
http://svn.apache.org/viewvc/phoenix/site/publish/language/functions.html?rev=1868598&r1=1868597&r2=1868598&view=diff
==============================================================================
--- phoenix/site/publish/language/functions.html (original)
+++ phoenix/site/publish/language/functions.html Fri Oct 18 15:06:28 2019
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2019-10-16
+ Generated by Apache Maven Doxia at 2019-10-18
Rendered using Reflow Maven Skin 1.1.0
(http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
Modified: phoenix/site/publish/language/index.html
URL:
http://svn.apache.org/viewvc/phoenix/site/publish/language/index.html?rev=1868598&r1=1868597&r2=1868598&view=diff
==============================================================================
--- phoenix/site/publish/language/index.html (original)
+++ phoenix/site/publish/language/index.html Fri Oct 18 15:06:28 2019
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2019-10-16
+ Generated by Apache Maven Doxia at 2019-10-18
Rendered using Reflow Maven Skin 1.1.0
(http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
Modified: phoenix/site/publish/secondary_indexing.html
URL:
http://svn.apache.org/viewvc/phoenix/site/publish/secondary_indexing.html?rev=1868598&r1=1868597&r2=1868598&view=diff
==============================================================================
--- phoenix/site/publish/secondary_indexing.html (original)
+++ phoenix/site/publish/secondary_indexing.html Fri Oct 18 15:06:28 2019
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2019-10-09
+ Generated by Apache Maven Doxia at 2019-10-18
Rendered using Reflow Maven Skin 1.1.0
(http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
@@ -350,17 +350,25 @@ CREATE LOCAL INDEX my_index ON my_table
<div class="section">
<h2 id="Setup">Setup</h2>
<p>Non transactional, mutable indexing requires special configuration options
on the region server and master to run - Phoenix ensures that they are setup
correctly when you enable mutable indexing on the table; if the correct
properties are not set, you will not be able to use secondary indexing. After
adding these settings to your hbase-site.xml, youâll need to do a rolling
restart of your cluster.</p>
- <p>You will need to add the following parameters to <tt>hbase-site.xml</tt>
on each region server:</p>
- <div class="source">
- <pre><property>
+ <p>As Phoenix matures, it needs less and less manual configuration. For older
Phoenix versions youâll need to add the properties listed for that version,
<i>as well as the properties listed for the later versions</i>.</p>
+ <div class="section">
+ <div class="section">
+ <h4 id="For_Phoenix_4.12_and_later">For Phoenix 4.12 and later</h4>
+ <p>You will need to add the following parameters to <tt>hbase-site.xml</tt>
on each region server:</p>
+ <div class="source">
+ <pre><property>
<name>hbase.regionserver.wal.codec</name>
<value>org.apache.hadoop.hbase.regionserver.wal.IndexedWALEditCodec</value>
</property>
</pre>
- </div>
- <p>The above property enables custom WAL edits to be written, ensuring proper
writing/replay of the index updates. This codec supports the usual host of
WALEdit options, most notably WALEdit compression.</p>
- <div class="source">
- <pre><property>
+ </div>
+ <p>The above property enables custom WAL edits to be written, ensuring
proper writing/replay of the index updates. This codec supports the usual host
of WALEdit options, most notably WALEdit compression.</p>
+ </div>
+ <div class="section">
+ <h4 id="For_Phoenix_4.8_-_4.11">For Phoenix 4.8 - 4.11</h4>
+ <p>The following configuration changes are also required to the server-side
hbase-site.xml on the master and regions server nodes:</p>
+ <div class="source">
+ <pre><property>
<name>hbase.region.server.rpc.scheduler.factory.class</name>
<value>org.apache.hadoop.hbase.ipc.PhoenixRpcSchedulerFactory</value>
<description>Factory to create the Phoenix RPC Scheduler that uses
separate queues for index and metadata updates</description>
@@ -371,11 +379,14 @@ CREATE LOCAL INDEX my_index ON my_table
<description>Factory to create the Phoenix RPC Scheduler that uses
separate queues for index and metadata updates</description>
</property>
</pre>
- </div>
- <p>The above properties prevent deadlocks from occurring during index
maintenance for global indexes (HBase 0.98.4+ and Phoenix 4.3.1+ only) by
ensuring index updates are processed with a higher priority than data updates.
It also prevents deadlocks by ensuring metadata rpc calls are processed with a
higher priority than data rpc calls.</p>
- <p>From Phoenix 4.8.0 onward, no configuration changes are required to use
local indexing. In Phoenix 4.7 and below, the following configuration changes
are required to the server-side hbase-site.xml on the master and regions server
nodes:</p>
- <div class="source">
- <pre><property>
+ </div>
+ <p>The above properties prevent deadlocks from occurring during index
maintenance for global indexes (HBase 0.98.4+ and Phoenix 4.3.1+) by ensuring
index updates are processed with a higher priority than data updates. It also
prevents deadlocks by ensuring metadata rpc calls are processed with a higher
priority than data rpc calls.</p>
+ </div>
+ <div class="section">
+ <h4 id="For_Phoenix_versions_4.7_and_below">For Phoenix versions 4.7 and
below</h4>
+ <p>The following configuration changes are also required to the server-side
hbase-site.xml on the master and regions server nodes:</p>
+ <div class="source">
+ <pre><property>
<name>hbase.master.loadbalancer.class</name>
<value>org.apache.phoenix.hbase.index.balancer.IndexLoadBalancer</value>
</property>
@@ -388,6 +399,9 @@ CREATE LOCAL INDEX my_index ON my_table
<value>org.apache.hadoop.hbase.regionserver.LocalIndexMerger</value>
</property>
</pre>
+ </div>
+ <p>The above properties are required to use local indexing.</p>
+ </div>
</div>
<div class="section">
<h3 id="Upgrading_Local_Indexes_created_before_4.8.0">Upgrading Local
Indexes created before 4.8.0</h3>
Modified: phoenix/site/source/src/site/markdown/secondary_indexing.md
URL:
http://svn.apache.org/viewvc/phoenix/site/source/src/site/markdown/secondary_indexing.md?rev=1868598&r1=1868597&r2=1868598&view=diff
==============================================================================
--- phoenix/site/source/src/site/markdown/secondary_indexing.md (original)
+++ phoenix/site/source/src/site/markdown/secondary_indexing.md Fri Oct 18
15:06:28 2019
@@ -226,6 +226,10 @@ it directly to Phoenix; although, such a
Non transactional, mutable indexing requires special configuration options on
the region server and master to run - Phoenix ensures that they are setup
correctly when you enable mutable indexing on the table; if the correct
properties are not set, you will not be able to use secondary indexing. After
adding these settings to your hbase-site.xml, you'll need to do a rolling
restart of your cluster.
+As Phoenix matures, it needs less and less manual configuration. For older
Phoenix versions you'll need to add the properties listed for that version, *as
well as the properties listed for the later versions*.
+
+#### For Phoenix 4.12 and later
+
You will need to add the following parameters to `hbase-site.xml` on each
region server:
```
@@ -237,6 +241,11 @@ You will need to add the following param
The above property enables custom WAL edits to be written, ensuring proper
writing/replay of the index updates. This codec supports the usual host of
WALEdit options, most notably WALEdit compression.
+
+#### For Phoenix 4.8 - 4.11
+
+The following configuration changes are also required to the server-side
hbase-site.xml on the master and regions server nodes:
+
```
<property>
<name>hbase.region.server.rpc.scheduler.factory.class</name>
@@ -250,9 +259,12 @@ The above property enables custom WAL ed
</property>
```
-The above properties prevent deadlocks from occurring during index maintenance
for global indexes (HBase 0.98.4+ and Phoenix 4.3.1+ only) by ensuring index
updates are processed with a higher priority than data updates. It also
prevents deadlocks by ensuring metadata rpc calls are processed with a higher
priority than data rpc calls.
-From Phoenix 4.8.0 onward, no configuration changes are required to use local
indexing. In Phoenix 4.7 and below, the following configuration changes are
required to the server-side hbase-site.xml on the master and regions server
nodes:
+The above properties prevent deadlocks from occurring during index maintenance
for global indexes (HBase 0.98.4+ and Phoenix 4.3.1+) by ensuring index updates
are processed with a higher priority than data updates. It also prevents
deadlocks by ensuring metadata rpc calls are processed with a higher priority
than data rpc calls.
+
+#### For Phoenix versions 4.7 and below
+
+The following configuration changes are also required to the server-side
hbase-site.xml on the master and regions server nodes:
```
<property>
@@ -268,6 +280,10 @@ From Phoenix 4.8.0 onward, no configurat
<value>org.apache.hadoop.hbase.regionserver.LocalIndexMerger</value>
</property>
```
+
+
+The above properties are required to use local indexing.
+
### Upgrading Local Indexes created before 4.8.0
While upgrading the Phoenix to 4.8.0+ version at server remove above three
local indexing related configurations from `hbase-site.xml` if present. From
client we are supporting both online(while initializing the connection from
phoenix client of 4.8.0+ versions) and offline(using psql tool) upgrade of
local indexes created before 4.8.0. As part of upgrade we recreate the local
indexes in ASYNC mode. After upgrade user need to build the indexes using
[IndexTool](http://phoenix.apache.org/secondary_indexing.html#Index_Population)
