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 2017/11/12 01:20:10 UTC
svn commit: r1814996 - in /phoenix: phoenix-docs/src/docsrc/help/phoenix.csv
phoenix-docs/src/tools/org/h2/build/doc/dictionary.txt
site/publish/language/datatypes.html site/publish/language/functions.html
site/publish/language/index.html
Author: jamestaylor
Date: Sun Nov 12 01:20:09 2017
New Revision: 1814996
URL: http://svn.apache.org/viewvc?rev=1814996&view=rev
Log:
Document new COLLATION_KEY function (Shehzaad Nakhoda)
Modified:
phoenix/phoenix-docs/src/docsrc/help/phoenix.csv
phoenix/phoenix-docs/src/tools/org/h2/build/doc/dictionary.txt
phoenix/site/publish/language/datatypes.html
phoenix/site/publish/language/functions.html
phoenix/site/publish/language/index.html
Modified: phoenix/phoenix-docs/src/docsrc/help/phoenix.csv
URL: http://svn.apache.org/viewvc/phoenix/phoenix-docs/src/docsrc/help/phoenix.csv?rev=1814996&r1=1814995&r2=1814996&view=diff
==============================================================================
--- phoenix/phoenix-docs/src/docsrc/help/phoenix.csv (original)
+++ phoenix/phoenix-docs/src/docsrc/help/phoenix.csv Sun Nov 12 01:20:09 2017
@@ -2187,3 +2187,19 @@ Replaces the byte at the given index in
","
SET_BYTE(CAST('FFFF' as BINARY), 1, 61)
"
+
+"Functions (String)","COLLATION_KEY","
+COLLATION_KEY( stringTerm, localeString [, upperCaseBoolean [, strengthInt [, decompositionInt ] ] ] )
+","
+Calculates a collation key that can be used to sort strings in a
+natural-language-aware way. The localeString must be of the form
+returned by the Java 6 implementation of java.util.Locale.toString()
+e.g. 'zh_TW_STROKE' or 'en_US' or 'fr_FR'. The third, fourth and fifth
+arguments are optional and determine respectively whether to use a
+special upper-case collator, the strength value of the collator, and
+the decomposition value of the collator. (See java.text.Collator to
+learn about strength and decomposition).
+","
+SELECT NAME FROM EMPLOYEE ORDER BY COLLATION_KEY(NAME, 'zh_TW')
+"
+
Modified: phoenix/phoenix-docs/src/tools/org/h2/build/doc/dictionary.txt
URL: http://svn.apache.org/viewvc/phoenix/phoenix-docs/src/tools/org/h2/build/doc/dictionary.txt?rev=1814996&r1=1814995&r2=1814996&view=diff
==============================================================================
--- phoenix/phoenix-docs/src/tools/org/h2/build/doc/dictionary.txt (original)
+++ phoenix/phoenix-docs/src/tools/org/h2/build/doc/dictionary.txt Sun Nov 12 01:20:09 2017
@@ -730,3 +730,4 @@ guideposts collects ilike rhs uniformly
hdfs myjar myincrement defaultvalue defualtvalue mypackage raised logarithm euler cbrt
transitioned overriden removal serially parallelized opposed frequency namely tranactional istransactional
guidepost compaction determination lookups currently presently whatever similarly posts tablesample
+learn fifth decomposition respectively
Modified: phoenix/site/publish/language/datatypes.html
URL: http://svn.apache.org/viewvc/phoenix/site/publish/language/datatypes.html?rev=1814996&r1=1814995&r2=1814996&view=diff
==============================================================================
--- phoenix/site/publish/language/datatypes.html (original)
+++ phoenix/site/publish/language/datatypes.html Sun Nov 12 01:20:09 2017
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2017-10-25
+ Generated by Apache Maven Doxia at 2017-11-11
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=1814996&r1=1814995&r2=1814996&view=diff
==============================================================================
--- phoenix/site/publish/language/functions.html (original)
+++ phoenix/site/publish/language/functions.html Sun Nov 12 01:20:09 2017
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2017-10-25
+ Generated by Apache Maven Doxia at 2017-11-11
Rendered using Reflow Maven Skin 1.1.0 (http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
@@ -275,6 +275,8 @@ syntax-end -->
<a href="#reverse" >REVERSE</a><br />
<a href="#to_char" >TO_CHAR</a><br />
+
+ <a href="#collation_key" >COLLATION_KEY</a><br />
</p>
syntax-end -->
<!-- railroad-start -->
@@ -311,6 +313,8 @@ syntax-end -->
<a href="#reverse" >REVERSE</a><br />
<a href="#to_char" >TO_CHAR</a><br />
+
+ <a href="#collation_key" >COLLATION_KEY</a><br />
</td>
</tr>
</table>
@@ -1728,6 +1732,24 @@ syntax-end -->
<p>Example:</p>
<p class="notranslate">TO_CHAR(myDate, '2001-02-03 04:05:06')<br />TO_CHAR(myDecimal, '#,##0.###')</p>
+<h3 id="collation_key" class="notranslate">COLLATION_KEY</h3>
+<!-- railroad-start -->
+<pre name="bnf" style="display: none">
+COLLATION_KEY( <a href="index.html#term">stringTerm</a>, <a href="index.html#string">localeString</a> [, <a href="index.html#boolean">upperCaseBoolean</a> [, <a href="index.html#int">strengthInt</a> [, <a href="index.html#int">decompositionInt</a> ] ] ] )
+</pre>
+<div name="railroad">
+<table class="railroad"><tr class="railroad"><td class="d"><code class="c">COLLATION_KEY ( <a href="index.html#term">stringTerm</a> , <a href="index.html#string">localeString</a></code></td><td class="d"><table class="railroad"><tr class="railroad"><td class="ts"></td><td class="d"> </td><td class="te"></td></tr><tr class="railroad"><td class="ls"></td><td class="d"><table class="railroad"><tr class="railroad"><td class="d"><code class="c">, <a href="index.html#boolean">upperCaseBoolean</a></code></td><td class="d"><table class="railroad"><tr class="railroad"><td class="ts"></td><td class="d"> </td><td class="te"></td></tr><tr class="railroad"><td class="ls"></td><td class="d"><table class="railroad"><tr class="railroad"><td class="d"><code class="c">, <a href="index.html#int">strengthInt</a></code></td><td class="d"><table class="railroad"><tr class="railroad"><td class="ts"></td><td class="d"> </td><td class="te"></td></tr><tr class="railroad"><td class="ls"></td><t
d class="d"><table class="railroad"><tr class="railroad"><td class="d"><code class="c">, <a href="index.html#int">decompositionInt</a></code></td></tr></table></td><td class="le"></td></tr></table></td></tr></table></td><td class="le"></td></tr></table></td></tr></table></td><td class="le"></td></tr></table></td><td class="d"><code class="c">)</code></td></tr></table>
+</div>
+<!-- railroad-end -->
+<!-- syntax-start
+<pre>
+COLLATION_KEY( <a href="index.html#term">stringTerm</a>, <a href="index.html#string">localeString</a> [, <a href="index.html#boolean">upperCaseBoolean</a> [, <a href="index.html#int">strengthInt</a> [, <a href="index.html#int">decompositionInt</a> ] ] ] )
+</pre>
+syntax-end -->
+<p>Calculates a collation key that can be used to sort strings in a natural-language-aware way. The localeString must be of the form returned by the Java 6 implementation of java.util.Locale.toString() e.g. 'zh_<code>TW_STROKE</code>' or 'en_<code>US</code>' or 'fr_<code>FR</code>'. The third, fourth and fifth arguments are optional and determine respectively whether to use a special upper-case collator, the strength value of the collator, and the decomposition value of the collator. (See java.text.Collator to learn about strength and decomposition).</p>
+<p>Example:</p>
+<p class="notranslate">SELECT NAME FROM EMPLOYEE ORDER BY COLLATION_KEY(NAME, 'zh_TW')</p>
+
<h3 id="to_date" class="notranslate">TO_DATE</h3>
<!-- railroad-start -->
<pre name="bnf" style="display: none">
Modified: phoenix/site/publish/language/index.html
URL: http://svn.apache.org/viewvc/phoenix/site/publish/language/index.html?rev=1814996&r1=1814995&r2=1814996&view=diff
==============================================================================
--- phoenix/site/publish/language/index.html (original)
+++ phoenix/site/publish/language/index.html Sun Nov 12 01:20:09 2017
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2017-10-25
+ Generated by Apache Maven Doxia at 2017-11-11
Rendered using Reflow Maven Skin 1.1.0 (http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">