Author: rajeshbabu
Date: Thu May 21 01:41:38 2015
New Revision: 1680721
URL: http://svn.apache.org/r1680721
Log:
PHOENIX-1982 Documentation for UDF support- addendum(Rajeshbabu)
Modified:
phoenix/phoenix-docs/src/docsrc/help/phoenix.csv
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=1680721&r1=1680720&r2=1680721&view=diff
==============================================================================
--- phoenix/phoenix-docs/src/docsrc/help/phoenix.csv (original)
+++ phoenix/phoenix-docs/src/docsrc/help/phoenix.csv Thu May 21 01:41:38 2015
@@ -562,11 +562,12 @@ RIGHT
"
"Other Grammar","Func Argument","
-dataType [CONSTANT [DEFUALTVALUE=string] [MINVALUE=string] [MAXVALUE=string]]
+dataType [CONSTANT] [DEFUALTVALUE=string] [MINVALUE=string] [MAXVALUE=string]
","
-The function argument is sql data type and it can be constant and when ever
it's constant we can provide default,min and max values in single quotes.
+The function argument is sql data type. It can be constant and also we can
provide default,min and max values for the argument in single quotes.
","
VARCHAR
+INTEGER DEFAULTVALUE='100'
INTEGER CONSTANT DEFAULTVALUE='10' MINVALUE='1' MAXVALUE='15'
"
Modified: phoenix/site/publish/language/index.html
URL:
http://svn.apache.org/viewvc/phoenix/site/publish/language/index.html?rev=1680721&r1=1680720&r2=1680721&view=diff
==============================================================================
--- phoenix/site/publish/language/index.html (original)
+++ phoenix/site/publish/language/index.html Thu May 21 01:41:38 2015
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2015-05-18
+ Generated by Apache Maven Doxia at 2015-05-21
Rendered using Reflow Maven Skin 1.1.0
(http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
@@ -265,8 +265,6 @@ syntax-end -->
<a href="#select_statement" >Select Statement</a><br />
- <a href="#select_statement" >Select Statement</a><br />
-
<a href="#split_point" >Split Point</a><br />
<a href="#table_spec" >Table Spec</a><br />
@@ -383,8 +381,6 @@ syntax-end -->
<a href="#select_statement" >Select Statement</a><br />
- <a href="#select_statement" >Select Statement</a><br />
-
<a href="#split_point" >Split Point</a><br />
<a href="#table_spec" >Table Spec</a><br />
@@ -431,9 +427,9 @@ syntax-end -->
<a href="#bind_parameter" >Bind Parameter</a><br />
<a href="#value" >Value</a><br />
+ </td><td class="index">
<a href="#case" >Case</a><br />
- </td><td class="index">
<a href="#case_when" >Case When</a><br />
@@ -1047,22 +1043,6 @@ syntax-end -->
<p>Example:</p>
<p class="notranslate">SELECT * FROM TEST;<br />SELECT DISTINCT NAME FROM
TEST;<br />SELECT ID, COUNT(1) FROM TEST GROUP BY ID;<br />SELECT NAME,
SUM(VAL) FROM TEST GROUP BY NAME HAVING COUNT(1) > 2;<br />SELECT
d.dept_id,e.dept_id,e.name FROM DEPT d JOIN EMPL e ON e.dept_id = d.dept_id;</p>
-<h3 id="select_statement" class="notranslate">Select Statement</h3>
-<!-- railroad-start -->
-<table class="railroad"><tr class="railroad"><td class="d"><code
class="c">SELECT</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#hint">hint</a> *
/</code></td></tr></table></td><td class="le"></td></tr></table></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="ts"></td><td class="d"><code class="c">DISTINCT</code></td><td
class="te"></td></tr><tr class="railroad"><td class="ls"></td><td
class="d"><code class="c">ALL</code></td><td
class="le"></td></tr></table></td><td class="le"></td></tr></table></td><td
class="d"><code class="c"><a href="index.ht
ml#select_expression">selectExpression</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"><code class="c">, ...</code></td><td
class="le"></td></tr></table></td></tr></table><br /><table
class="railroad"><tr class="railroad"><td class="d"><code class="c">FROM <a
href="index.html#table_spec">tableSpec</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"><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"><code class="c"><a
href="index.html#join_type">joinType</a></code></td><td
class="le"></td></tr></table></td><td class=
"d"><code class="c">JOIN <a href="index.html#table_spec">tableSpec</a> ON <a
href="index.html#expression">expression</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"><code class="c">...</code></td><td
class="le"></td></tr></table></td></tr></table></td><td
class="le"></td></tr></table></td></tr></table><br /><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">WHERE <a
href="index.html#expression">expression</a></code></td></tr></table></td><td
class="le"></td></tr></table><br /><table class="railroad"><tr
class="railroad"><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">GROUP BY <a
href="index.html#expression">expression</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"><code class="c">, ...</code></td><td
class="le"></td></tr></table></td></tr></table></td><td
class="le"></td></tr></table></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">HAVING <a
href="index.html#expression">expression</a></code></td></tr></table></td><td
class="le"></td></tr></table></td></tr></table>
-<!-- railroad-end -->
-<!-- syntax-start
-<pre>
-SELECT [/*+ <a href="index.html#hint">hint</a> */] [DISTINCT | ALL] <a
href="index.html#select_expression">selectExpression</a> [,...]
-FROM <a href="index.html#table_spec">tableSpec</a> [ { [<a
href="index.html#join_type">joinType</a>] JOIN <a
href="index.html#table_spec">tableSpec</a> ON <a
href="index.html#expression">expression</a> } [...] ]
-[ WHERE <a href="index.html#expression">expression</a> ]
-[ GROUP BY <a href="index.html#expression">expression</a> [,...] ] [ HAVING <a
href="index.html#expression">expression</a> ]
-</pre>
-syntax-end -->
-<p>Selects data from a table. <code>DISTINCT</code> filters out duplicate
results while <code>ALL</code>, the default, includes all results.
<code>FROM</code> identifies the table being queried. Columns may be
dynamically defined in parenthesis after the table name and then used in the
query. Joins are processed in reverse order through a broadcast hash join
mechanism. For best performance, order tables from largest to smallest in terms
of how many rows you expect to be used from each table. <code>GROUP BY</code>
groups the the result by the given expression(s). <code>HAVING</code> filters
rows after grouping. An optional hint may be used to override decisions made by
the query optimizer.</p>
-<p>Example:</p>
-<p class="notranslate">SELECT * FROM TEST;<br />SELECT DISTINCT NAME FROM
TEST;<br />SELECT ID, COUNT(1) FROM TEST GROUP BY ID;<br />SELECT NAME,
SUM(VAL) FROM TEST GROUP BY NAME HAVING COUNT(1) > 2;<br />SELECT
d.dept_id,e.dept_id,e.name FROM DEPT d JOIN EMPL e ON e.dept_id = d.dept_id;</p>
-
<h3 id="split_point" class="notranslate">Split Point</h3>
<!-- railroad-start -->
<table class="railroad"><tr class="railroad"><td class="ts"></td><td
class="d"><code class="c"><a href="index.html#value">value</a></code></td><td
class="te"></td></tr><tr class="railroad"><td class="ls"></td><td
class="d"><code class="c"><a
href="index.html#bind_parameter">bindParameter</a></code></td><td
class="le"></td></tr></table>
@@ -1117,16 +1097,16 @@ syntax-end -->
<h3 id="func_argument" class="notranslate">Func Argument</h3>
<!-- railroad-start -->
-<table class="railroad"><tr class="railroad"><td class="d"><code class="c"><a
href="index.html#data_type">dataType</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">CONSTANT</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">DEFUALTVALUE = <a
href="index.html#string">string</a></code></td></tr></table></td><td
class="le"></td></tr></table></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">MINVALUE = <a
href="index.html#string">string</a></code></td></tr></table></td><td
class="le"></td></tr></table></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">MAXVALUE = <a
href="index.html#string">string</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>
+<table class="railroad"><tr class="railroad"><td class="d"><code class="c"><a
href="index.html#data_type">dataType</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"><code class="c">CONSTANT</code></td><td
class="le"></td></tr></table></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">DEFUALTVALUE = <a
href="index.html#string">string</a></code></td></tr></table></td><td
class="le"></td></tr></table></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">MINVALUE = <a
href="index.html#string">string</a></code></td></tr></table></td><td
class="le"></td></tr></table></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">MAXVALUE = <a
href="index.html#string">string</a></code></td></tr></table></td><td
class="le"></td></tr></table></td></tr></table>
<!-- railroad-end -->
<!-- syntax-start
<pre>
-<a href="index.html#data_type">dataType</a> [CONSTANT [DEFUALTVALUE=<a
href="index.html#string">string</a>] [MINVALUE=<a
href="index.html#string">string</a>] [MAXVALUE=<a
href="index.html#string">string</a>]]
+<a href="index.html#data_type">dataType</a> [CONSTANT] [DEFUALTVALUE=<a
href="index.html#string">string</a>] [MINVALUE=<a
href="index.html#string">string</a>] [MAXVALUE=<a
href="index.html#string">string</a>]
</pre>
syntax-end -->
-<p>The function argument is sql data type and it can be constant and when ever
it's constant we can provide default,min and max values in single
quotes.</p>
+<p>The function argument is sql data type. It can be constant and also we can
provide default,min and max values for the argument in single quotes.</p>
<p>Example:</p>
-<p class="notranslate">VARCHAR<br />INTEGER CONSTANT DEFAULTVALUE='10'
MINVALUE='1' MAXVALUE='15'</p>
+<p class="notranslate">VARCHAR<br />INTEGER DEFAULTVALUE='100'<br
/>INTEGER CONSTANT DEFAULTVALUE='10' MINVALUE='1'
MAXVALUE='15'</p>
<h3 id="class_name" class="notranslate">Class Name</h3>
<!-- railroad-start -->
