You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@phoenix.apache.org by st...@apache.org on 2023/02/07 08:02:21 UTC
svn commit: r1907490 - in /phoenix: phoenix-docs/src/docsrc/help/phoenix.csv site/publish/download.html site/publish/index.html site/publish/language/datatypes.html site/publish/language/functions.html site/publish/language/index.html
Author: stoty
Date: Tue Feb 7 08:02:21 2023
New Revision: 1907490
URL: http://svn.apache.org/viewvc?rev=1907490&view=rev
Log:
PHOENIX-6848 Fix grant and revoke command rule documentation
Modified:
phoenix/phoenix-docs/src/docsrc/help/phoenix.csv
phoenix/site/publish/download.html
phoenix/site/publish/index.html
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=1907490&r1=1907489&r2=1907490&view=diff
==============================================================================
--- phoenix/phoenix-docs/src/docsrc/help/phoenix.csv (original)
+++ phoenix/phoenix-docs/src/docsrc/help/phoenix.csv Tue Feb 7 08:02:21 2023
@@ -372,7 +372,7 @@ DROP SCHEMA my_schema
"
"Commands","GRANT","
-GRANT {permissionString} [ON [SCHEMA schemaName] tableName] TO [GROUP] userString
+GRANT {permissionString} [ON { {SCHEMA schemaName} | tableRef}] TO [GROUP] userString
","
Grant permissions at table, schema or user level. Permissions are managed by HBase in hbase:acl table, hence access controls need to be enabled. This feature will be available from Phoenix 4.14 version onwards.
@@ -398,7 +398,7 @@ GRANT 'A' ON SCHEMA my_schema TO 'User3'
"
"Commands","REVOKE","
-REVOKE [ON [SCHEMA schemaName] tableName] FROM [GROUP] userString
+REVOKE [ON { {SCHEMA schemaName} | tableRef}] FROM [GROUP] userString
","
Revoke permissions at table, schema or user level. Permissions are managed by HBase in hbase:acl table, hence access controls need to be enabled. This feature will be available from Phoenix 4.14 version onwards.
@@ -1974,7 +1974,7 @@ similarly to the single-argument ""TO_DA
","
TO_DATE('Sat, 3 Feb 2001 03:05:06 GMT', 'EEE, d MMM yyyy HH:mm:ss z')
TO_DATE('1970-01-01', 'yyyy-MM-dd', 'GMT+1')
-date "1970-01-01 12:30:00"
+date '1970-01-01 12:30:00'
"
"Functions (Time and Date)","CURRENT_DATE","
Modified: phoenix/site/publish/download.html
URL: http://svn.apache.org/viewvc/phoenix/site/publish/download.html?rev=1907490&r1=1907489&r2=1907490&view=diff
==============================================================================
--- phoenix/site/publish/download.html (original)
+++ phoenix/site/publish/download.html Tue Feb 7 08:02:21 2023
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2023-01-21
+ Generated by Apache Maven Doxia at 2023-02-07
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/index.html
URL: http://svn.apache.org/viewvc/phoenix/site/publish/index.html?rev=1907490&r1=1907489&r2=1907490&view=diff
==============================================================================
--- phoenix/site/publish/index.html (original)
+++ phoenix/site/publish/index.html Tue Feb 7 08:02:21 2023
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2023-01-21
+ Generated by Apache Maven Doxia at 2023-02-07
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/datatypes.html
URL: http://svn.apache.org/viewvc/phoenix/site/publish/language/datatypes.html?rev=1907490&r1=1907489&r2=1907490&view=diff
==============================================================================
--- phoenix/site/publish/language/datatypes.html (original)
+++ phoenix/site/publish/language/datatypes.html Tue Feb 7 08:02:21 2023
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2023-01-21
+ Generated by Apache Maven Doxia at 2023-02-07
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=1907490&r1=1907489&r2=1907490&view=diff
==============================================================================
--- phoenix/site/publish/language/functions.html (original)
+++ phoenix/site/publish/language/functions.html Tue Feb 7 08:02:21 2023
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2023-01-21
+ Generated by Apache Maven Doxia at 2023-02-07
Rendered using Reflow Maven Skin 1.1.0 (http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
@@ -333,6 +333,8 @@ syntax-end -->
<a href="#to_date" >TO_DATE</a><br />
+ <a href="#current_date" >CURRENT_DATE</a><br />
+
<a href="#to_time" >TO_TIME</a><br />
<a href="#to_timestamp" >TO_TIMESTAMP</a><br />
@@ -371,6 +373,8 @@ syntax-end -->
<a href="#to_date" >TO_DATE</a><br />
+ <a href="#current_date" >CURRENT_DATE</a><br />
+
<a href="#to_time" >TO_TIME</a><br />
<a href="#to_timestamp" >TO_TIMESTAMP</a><br />
@@ -378,9 +382,9 @@ syntax-end -->
<a href="#current_time" >CURRENT_TIME</a><br />
<a href="#convert_tz" >CONVERT_TZ</a><br />
+ </td><td class="index">
<a href="#timezone_offset" >TIMEZONE_OFFSET</a><br />
- </td><td class="index">
<a href="#now" >NOW</a><br />
@@ -391,9 +395,9 @@ syntax-end -->
<a href="#week" >WEEK</a><br />
<a href="#dayofyear" >DAYOFYEAR</a><br />
+ </td><td class="index">
<a href="#dayofmonth" >DAYOFMONTH</a><br />
- </td><td class="index">
<a href="#dayofweek" >DAYOFWEEK</a><br />
@@ -1773,7 +1777,25 @@ TO_DATE( <a href="index.html#term">strin
syntax-end -->
<p>Parses a string and returns a date. Note that the returned date is internally represented as the number of milliseconds since the java epoch. The most important format characters are: y year, M month, d day, H hour, m minute, s second. The default format string is <code>yyyy-MM-dd HH:mm:ss</code>. For details of the format, see <code>java.text.SimpleDateFormat</code>. By default, <code>GMT</code> will be used as the time zone when parsing the date. However, a time zone id can also be supplied. This is a time zone id such as '<code>GMT</code>+1'. If 'local' is provided as the time zone id, the local time zone will be used for parsing. The configuration setting <code>phoenix.query.dateFormatTimeZone</code> can also be set to a time zone id, which will cause the default of <code>GMT</code> to be overridden with the configured time zone id. Please see the Data Type reference guide about how Apache Phoenix presently defines the <code>DATE</code> datatype. Additionally,
Phoenix supports the <code>ANSI SQL date</code> literal which acts similarly to the single-argument <code>TO_DATE</code> function.</p>
<p>Example:</p>
-<p class="notranslate">TO_DATE('Sat, 3 Feb 2001 03:05:06 GMT', 'EEE, d MMM yyyy HH:mm:ss z')<br />TO_DATE('1970-01-01', 'yyyy-MM-dd', 'GMT+1')<br />date</p>
+<p class="notranslate">TO_DATE('Sat, 3 Feb 2001 03:05:06 GMT', 'EEE, d MMM yyyy HH:mm:ss z')<br />TO_DATE('1970-01-01', 'yyyy-MM-dd', 'GMT+1')<br />date '1970-01-01 12:30:00'</p>
+
+<h3 id="current_date" class="notranslate">CURRENT_DATE</h3>
+<!-- railroad-start -->
+<pre name="bnf" style="display: none">
+CURRENT_DATE()
+</pre>
+<div name="railroad">
+<table class="railroad"><tr class="railroad"><td class="d"><code class="c">CURRENT_DATE ( )</code></td></tr></table>
+</div>
+<!-- railroad-end -->
+<!-- syntax-start
+<pre>
+CURRENT_DATE()
+</pre>
+syntax-end -->
+<p>Returns the current server-side date, bound at the start of the execution of a query based on the current time on the region server owning the metadata of the table being queried. Please see the Data Type reference guide about how Apache Phoenix presently defines the <code>DATE</code> datatype.</p>
+<p>Example:</p>
+<p class="notranslate">CURRENT_DATE()</p>
<h3 id="to_time" class="notranslate">TO_TIME</h3>
<!-- railroad-start -->
Modified: phoenix/site/publish/language/index.html
URL: http://svn.apache.org/viewvc/phoenix/site/publish/language/index.html?rev=1907490&r1=1907489&r2=1907490&view=diff
==============================================================================
--- phoenix/site/publish/language/index.html (original)
+++ phoenix/site/publish/language/index.html Tue Feb 7 08:02:21 2023
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2023-01-21
+ Generated by Apache Maven Doxia at 2023-02-07
Rendered using Reflow Maven Skin 1.1.0 (http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
@@ -1050,15 +1050,15 @@ DROP SCHEMA IF EXISTS my_schema<br />DRO
<h3 id="grant" class="notranslate">GRANT</h3>
<!-- railroad-start -->
<pre name="bnf" style="display: none">
-GRANT {<a href="index.html#string">permissionString</a>} [ON [SCHEMA <a href="index.html#name">schemaName</a>] <a href="index.html#name">tableName</a>] TO [GROUP] <a href="index.html#string">userString</a>
+GRANT {<a href="index.html#string">permissionString</a>} [ON { {SCHEMA <a href="index.html#name">schemaName</a>} | <a href="index.html#table_ref">tableRef</a>}] TO [GROUP] <a href="index.html#string">userString</a>
</pre>
<div name="railroad">
-<table class="railroad"><tr class="railroad"><td class="d"><code class="c">GRANT <a href="index.html#string">permissionString</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">ON</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">SCHEMA <a href="index.html#name">schemaName</a></code></td></tr></table></td><td class="le"></td></tr></table></td><td class="d"><code class="c"><a href="index.html#name">tableName</a></code></td></tr></table></td><td class="le"></td></tr></table></td><td class="d"><code class="c">TO</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">GROUP</code></td><td class="le"></td></tr></table></td><td class="d"><code class="c"><a href="index.html#string">userString</a></code></td></tr></table>
+<table class="railroad"><tr class="railroad"><td class="d"><code class="c">GRANT <a href="index.html#string">permissionString</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">ON</code></td><td class="d"><table class="railroad"><tr class="railroad"><td class="ts"></td><td class="d"><table class="railroad"><tr class="railroad"><td class="d"><code class="c">SCHEMA <a href="index.html#name">schemaName</a></code></td></tr></table></td><td class="te"></td></tr><tr class="railroad"><td class="ls"></td><td class="d"><code class="c"><a href="index.html#table_ref">tableRef</a></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">TO</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">GROUP</code></td><td class="le"></td></tr></table></td><td class="d"><code class="c"><a href="index.html#string">userString</a></code></td></tr></table>
</div>
<!-- railroad-end -->
<!-- syntax-start
<pre>
-GRANT {<a href="index.html#string">permissionString</a>} [ON [SCHEMA <a href="index.html#name">schemaName</a>] <a href="index.html#name">tableName</a>] TO [GROUP] <a href="index.html#string">userString</a>
+GRANT {<a href="index.html#string">permissionString</a>} [ON { {SCHEMA <a href="index.html#name">schemaName</a>} | <a href="index.html#table_ref">tableRef</a>}] TO [GROUP] <a href="index.html#string">userString</a>
</pre>
syntax-end -->
<p>Grant permissions at table, schema or user level. Permissions are managed by <code>HBase</code> in hbase:acl table, hence access controls need to be enabled. This feature will be available from Phoenix 4.14 version onwards.</p><p>Possible permissions are R - Read, W - Write, X - Execute, C - Create and A - Admin. To enable/disable access controls, see https://hbase.apache.org/book.html#hbase.accesscontrol.configuration</p><p>Permissions should be granted on base tables. It will be propagated to all its indexes and views. Group permissions are applicable to all users in the group and schema permissions are applicable to all tables with that schema. Grant statements without table/schema specified are assigned at <code>GLOBAL</code> level.</p><p>Phoenix doesn't expose Execute('X') functionality to end users. However, it is required for mutable tables with secondary indexes.</p><p>Important Note:</p><p>Every user requires '<code>RX</code>' permissions on all Phoen
ix <code>SYSTEM</code> tables in order to work correctly. Users also require '<code>RWX</code>' permissions on <code>SYSTEM.SEQUENCE</code> table for using <code>SEQUENCES</code>.</p>
@@ -1069,15 +1069,15 @@ GRANT 'RXC' TO 'User1'<b
<h3 id="revoke" class="notranslate">REVOKE</h3>
<!-- railroad-start -->
<pre name="bnf" style="display: none">
-REVOKE [ON [SCHEMA <a href="index.html#name">schemaName</a>] <a href="index.html#name">tableName</a>] FROM [GROUP] <a href="index.html#string">userString</a>
+REVOKE [ON { {SCHEMA <a href="index.html#name">schemaName</a>} | <a href="index.html#table_ref">tableRef</a>}] FROM [GROUP] <a href="index.html#string">userString</a>
</pre>
<div name="railroad">
-<table class="railroad"><tr class="railroad"><td class="d"><code class="c">REVOKE</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">ON</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">SCHEMA <a href="index.html#name">schemaName</a></code></td></tr></table></td><td class="le"></td></tr></table></td><td class="d"><code class="c"><a href="index.html#name">tableName</a></code></td></tr></table></td><td class="le"></td></tr></table></td><td class="d"><code class="c">FROM</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">GROUP</code></td><td class="le"></td></tr></table></td><td class="d"><code class="c"><a href="index.html#string">userString</a></code></td></tr></table>
+<table class="railroad"><tr class="railroad"><td class="d"><code class="c">REVOKE</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">ON</code></td><td class="d"><table class="railroad"><tr class="railroad"><td class="ts"></td><td class="d"><table class="railroad"><tr class="railroad"><td class="d"><code class="c">SCHEMA <a href="index.html#name">schemaName</a></code></td></tr></table></td><td class="te"></td></tr><tr class="railroad"><td class="ls"></td><td class="d"><code class="c"><a href="index.html#table_ref">tableRef</a></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">FROM</code></td><td class="d"><table class="railroad"><tr class="railroad"><td class="ts"></td><td class="d">&n
bsp;</td><td class="te"></td></tr><tr class="railroad"><td class="ls"></td><td class="d"><code class="c">GROUP</code></td><td class="le"></td></tr></table></td><td class="d"><code class="c"><a href="index.html#string">userString</a></code></td></tr></table>
</div>
<!-- railroad-end -->
<!-- syntax-start
<pre>
-REVOKE [ON [SCHEMA <a href="index.html#name">schemaName</a>] <a href="index.html#name">tableName</a>] FROM [GROUP] <a href="index.html#string">userString</a>
+REVOKE [ON { {SCHEMA <a href="index.html#name">schemaName</a>} | <a href="index.html#table_ref">tableRef</a>}] FROM [GROUP] <a href="index.html#string">userString</a>
</pre>
syntax-end -->
<p>Revoke permissions at table, schema or user level. Permissions are managed by <code>HBase</code> in hbase:acl table, hence access controls need to be enabled. This feature will be available from Phoenix 4.14 version onwards.</p><p>To enable/disable access controls, see https://hbase.apache.org/book.html#hbase.accesscontrol.configuration</p><p>Group permissions are applicable to all users in the group and schema permissions are applicable to all tables with that schema. Permissions should be revoked on base tables. It will be propagated to all its indexes and views. Revoke statements without table/schema specified are assigned at <code>GLOBAL</code> level.</p><p>Revoke removes all the permissions at that level.</p><p>Important Note:</p><p>Revoke permissions needs to be exactly at the same level as permissions assigned via Grant permissions statement. Level refers to table, schema or user. Revoking any of '<code>RX</code>' permissions on any Phoenix <code>SYSTEM</code> tabl
es will cause exceptions. Revoking any of '<code>RWX</code>' permissions on <code>SYSTEM.SEQUENCE</code> will cause exceptions while accessing sequences.</p><p>The examples below are for revoking permissions granted using the examples from <code>GRANT</code> statement above.</p>