Author: rajeshbabu
Date: Thu May 21 16:42:01 2015
New Revision: 1680925
URL: http://svn.apache.org/r1680925
Log:
PHOENIX-1982 Documentation for UDF support-addendum
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=1680925&r1=1680924&r2=1680925&view=diff
==============================================================================
--- phoenix/phoenix-docs/src/docsrc/help/phoenix.csv (original)
+++ phoenix/phoenix-docs/src/docsrc/help/phoenix.csv Thu May 21 16:42:01 2015
@@ -96,16 +96,18 @@ DROP TABLE my_schema.my_table CASCADE;
"
"Commands","CREATE FUNCTION","
-CREATE FUNCTION funcName
+CREATE [TEMPORARY] FUNCTION funcName
([funcArgument[,...]])
RETURNS dataType AS className [USING JAR jarPath]
","
Creates a new function. The function name is uppercased unless they are double
quoted in which case they are case sensitive. The function accepts zero or more
arguments. The class name and jar path should be in single quotes. The jar path
is optional and if not specified then the class name will be loaded from the
jars present in directory configured for hbase.dynamic.jars.dir.
","
+
CREATE FUNCTION my_reverse(varchar) returns varchar as
'com.mypackage.MyReverseFunction' using jar
'hdfs:/localhost:8080/hbase/lib/myjar.jar'
CREATE FUNCTION my_reverse(varchar) returns varchar as
'com.mypackage.MyReverseFunction'
CREATE FUNCTION my_increment(integer, integer constant defaultvalue='10')
returns integer as 'com.mypackage.MyIncrementFunction' using jar
'/hbase/lib/myincrement.jar'
+CREATE TEMPORARY FUNCTION my_reverse(varchar) returns varchar as
'com.mypackage.MyReverseFunction' using jar
'hdfs:/localhost:8080/hbase/lib/myjar.jar'
"
"Commands","DROP FUNCTION","
Modified: phoenix/site/publish/language/index.html
URL:
http://svn.apache.org/viewvc/phoenix/site/publish/language/index.html?rev=1680925&r1=1680924&r2=1680925&view=diff
==============================================================================
--- phoenix/site/publish/language/index.html (original)
+++ phoenix/site/publish/language/index.html Thu May 21 16:42:01 2015
@@ -593,17 +593,17 @@ DROP TABLE my_schema.my_table;<br />DROP
<h3 id="create_function" class="notranslate">CREATE FUNCTION</h3>
<!-- railroad-start -->
<pre name="bnf" style="display: none">
-CREATE FUNCTION <a href="index.html#name">funcName</a>
+CREATE [TEMPORARY] FUNCTION <a href="index.html#name">funcName</a>
([<a href="index.html#func_argument">funcArgument</a>[,...]])
RETURNS <a href="index.html#data_type">dataType</a> AS <a
href="index.html#class_name">className</a> [USING JAR <a
href="index.html#jar_path">jarPath</a>]
</pre>
<div name="railroad">
-<table class="railroad"><tr class="railroad"><td class="d"><code
class="c">CREATE FUNCTION <a
href="index.html#name">funcName</a></code></td></tr></table><br /><table
class="railroad"><tr class="railroad"><td class="d"><code
class="c">(</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#func_argument">funcArgument</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"><code
class="c">)</code></td></tr></table><br /><table class="railroad"><tr
class="railroad"><td class
="d"><code class="c">RETURNS <a href="index.html#data_type">dataType</a> AS <a
href="index.html#class_name">className</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">USING JAR <a
href="index.html#jar_path">jarPath</a></code></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">CREATE</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">TEMPORARY</code></td><td
class="le"></td></tr></table></td><td class="d"><code class="c">FUNCTION <a
href="index.html#name">funcName</a></code></td></tr></table><br /><table
class="railroad"><tr class="railroad"><td class="d"><code
class="c">(</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#func_argument">funcArgument</a></code></td><td
class="d"><table class="railroad"><tr class="railroad"><td class="ts"></td><td
class="d"> </td><td class="te"></td></t
r><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"><code
class="c">)</code></td></tr></table><br /><table class="railroad"><tr
class="railroad"><td class="d"><code class="c">RETURNS <a
href="index.html#data_type">dataType</a> AS <a
href="index.html#class_name">className</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">USING JAR <a
href="index.html#jar_path">jarPath</a></code></td></tr></table></td><td
class="le"></td></tr></table></td></tr></table>
</div>
<!-- railroad-end -->
<!-- syntax-start
<pre>
-CREATE FUNCTION <a href="index.html#name">funcName</a>
+CREATE [TEMPORARY] FUNCTION <a href="index.html#name">funcName</a>
([<a href="index.html#func_argument">funcArgument</a>[,...]])
RETURNS <a href="index.html#data_type">dataType</a> AS <a
href="index.html#class_name">className</a> [USING JAR <a
href="index.html#jar_path">jarPath</a>]
</pre>
@@ -611,7 +611,7 @@ syntax-end -->
<p>Creates a new function. The function name is uppercased unless they are
double quoted in which case they are case sensitive. The function accepts zero
or more arguments. The class name and jar path should be in single quotes. The
jar path is optional and if not specified then the class name will be loaded
from the jars present in directory configured for hbase.dynamic.jars.dir.</p>
<p>Example:</p>
<p class="notranslate">
-CREATE FUNCTION my_reverse(varchar) returns varchar as
'com.mypackage.MyReverseFunction' using jar
'hdfs:/localhost:8080/hbase/lib/myjar.jar'<br />CREATE FUNCTION
my_reverse(varchar) returns varchar as
'com.mypackage.MyReverseFunction'<br />CREATE FUNCTION
my_increment(integer, integer constant defaultvalue='10') returns
integer as 'com.mypackage.MyIncrementFunction' using jar
'/hbase/lib/myincrement.jar'</p>
+CREATE FUNCTION my_reverse(varchar) returns varchar as
'com.mypackage.MyReverseFunction' using jar
'hdfs:/localhost:8080/hbase/lib/myjar.jar'<br />CREATE FUNCTION
my_reverse(varchar) returns varchar as
'com.mypackage.MyReverseFunction'<br />CREATE FUNCTION
my_increment(integer, integer constant defaultvalue='10') returns
integer as 'com.mypackage.MyIncrementFunction' using jar
'/hbase/lib/myincrement.jar'<br />CREATE TEMPORARY FUNCTION
my_reverse(varchar) returns varchar as
'com.mypackage.MyReverseFunction' using jar
'hdfs:/localhost:8080/hbase/lib/myjar.jar'</p>
<h3 id="drop_function" class="notranslate">DROP FUNCTION</h3>
<!-- railroad-start -->
