Author: elserj
Date: Thu Sep 1 17:01:49 2016
New Revision: 1758811
URL: http://svn.apache.org/viewvc?rev=1758811&view=rev
Log:
PHOENIX-2990 Document lack of JDBC compliance with some data types
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=1758811&r1=1758810&r2=1758811&view=diff
==============================================================================
--- phoenix/phoenix-docs/src/docsrc/help/phoenix.csv (original)
+++ phoenix/phoenix-docs/src/docsrc/help/phoenix.csv Thu Sep 1 17:01:49 2016
@@ -1202,7 +1202,10 @@ The binary representation is an 8 byte l
possible (although not necessarily recommended) to store more information
within a TIME column
than what is provided by ""java.sql.Time"". Note that the internal
representation is based on
a number of milliseconds since the epoch (which is based on a time in GMT),
while
-""java.sql.Time"" will format times based on the client's local time zone.
+""java.sql.Time"" will format times based on the client's local time zone.
Please note that
+this TIME type is different than the TIME type as defined by the SQL 92
standard in that it
+includes year, month, and day components. As such, it is not in compliance
with the JDBC APIs.
+As the underlying data is still stored as a long, only the presentation of the
value is incorrect.
","
TIME
"
@@ -1216,7 +1219,10 @@ The binary representation is an 8 byte l
possible (although not necessarily recommended) to store more information
within a DATE column than
what is provided by ""java.sql.Date"". Note that the internal representation
is based on a number
of milliseconds since the epoch (which is based on a time in GMT), while
""java.sql.Date""
-will format dates based on the client's local time zone.
+will format dates based on the client's local time zone. Please note that this
DATE type
+is different than the DATE type as defined by the SQL 92 standard in that it
includes
+a time component. As such, it is not in compliance with the JDBC APIs. As the
underlying data
+is still stored as a long, only the presentation of the value is incorrect.
","
DATE
"
@@ -1809,7 +1815,8 @@ time zone id, the local time zone will b
The configuration setting ""phoenix.query.dateFormatTimeZone""
can also be set to a time zone id, which will cause the
default of GMT to be overridden with the configured
-time zone id.
+time zone id. Please see the Data Type reference guide about
+how Apache Phoenix presently defines the DATE datatype.
","
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')
@@ -1820,7 +1827,8 @@ CURRENT_DATE()
","
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.
+metadata of the table being queried. Please see the Data Type reference guide
+about how Apache Phoenix presently defines the DATE datatype.
","
CURRENT_DATE()
"
@@ -1829,7 +1837,8 @@ CURRENT_DATE()
CURRENT_TIME()
","
Same as CURRENT_DATE(), except returns a value of type TIME. In either case,
-the underlying representation is the epoch time as a long value.
+the underlying representation is the epoch time as a long value. Please see the
+Data Type reference guide about how Apache Phoenix presently defines the TIME
datatype.
","
CURRENT_TIME()
"
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=1758811&r1=1758810&r2=1758811&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 Thu Sep 1
17:01:49 2016
@@ -729,4 +729,4 @@ rpc doled paranthesis reaching satisfy c
guideposts collects ilike rhs uniformly ttl reviewer ranking earth
hdfs myjar myincrement defaultvalue defualtvalue mypackage raised logarithm
euler cbrt
transitioned overriden removal serially parallelized opposed frequency namely
tranactional istransactional
-guidepost compaction determination lookups
+guidepost compaction determination lookups currently presently
Modified: phoenix/site/publish/language/datatypes.html
URL:
http://svn.apache.org/viewvc/phoenix/site/publish/language/datatypes.html?rev=1758811&r1=1758810&r2=1758811&view=diff
==============================================================================
--- phoenix/site/publish/language/datatypes.html (original)
+++ phoenix/site/publish/language/datatypes.html Thu Sep 1 17:01:49 2016
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2016-08-19
+ Generated by Apache Maven Doxia at 2016-09-01
Rendered using Reflow Maven Skin 1.1.0
(http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
@@ -534,7 +534,7 @@ TIME
TIME
</pre>
syntax-end -->
-<p>The time data type. The format is yyyy-<code>MM</code>-dd hh:mm:ss, with
both the date and time parts maintained. Mapped to <code>java.sql.Time</code>.
The binary representation is an 8 byte long (the number of milliseconds from
the epoch), making it possible (although not necessarily recommended) to store
more information within a <code>TIME</code> column than what is provided by
<code>java.sql.Time</code>. Note that the internal representation is based on a
number of milliseconds since the epoch (which is based on a time in
<code>GMT</code>), while <code>java.sql.Time</code> will format times based on
the client's local time zone.</p>
+<p>The time data type. The format is yyyy-<code>MM</code>-dd hh:mm:ss, with
both the date and time parts maintained. Mapped to <code>java.sql.Time</code>.
The binary representation is an 8 byte long (the number of milliseconds from
the epoch), making it possible (although not necessarily recommended) to store
more information within a <code>TIME</code> column than what is provided by
<code>java.sql.Time</code>. Note that the internal representation is based on a
number of milliseconds since the epoch (which is based on a time in
<code>GMT</code>), while <code>java.sql.Time</code> will format times based on
the client's local time zone. Please note that this <code>TIME</code> type
is different than the <code>TIME</code> type as defined by the SQL 92 standard
in that it includes year, month, and day components. As such, it is not in
compliance with the <code>JDBC APIs</code>. As the underlying data is still
stored as a long, only the presentation of the value is incorrect.</p>
<p>Example:</p>
<p class="notranslate">TIME</p>
@@ -552,7 +552,7 @@ DATE
DATE
</pre>
syntax-end -->
-<p>The date data type. The format is yyyy-<code>MM</code>-dd hh:mm:ss, with
both the date and time parts maintained to a millisecond accuracy. Mapped to
<code>java.sql.Date</code>. The binary representation is an 8 byte long (the
number of milliseconds from the epoch), making it possible (although not
necessarily recommended) to store more information within a <code>DATE</code>
column than what is provided by <code>java.sql.Date</code>. Note that the
internal representation is based on a number of milliseconds since the epoch
(which is based on a time in <code>GMT</code>), while
<code>java.sql.Date</code> will format dates based on the client's local
time zone.</p>
+<p>The date data type. The format is yyyy-<code>MM</code>-dd hh:mm:ss, with
both the date and time parts maintained to a millisecond accuracy. Mapped to
<code>java.sql.Date</code>. The binary representation is an 8 byte long (the
number of milliseconds from the epoch), making it possible (although not
necessarily recommended) to store more information within a <code>DATE</code>
column than what is provided by <code>java.sql.Date</code>. Note that the
internal representation is based on a number of milliseconds since the epoch
(which is based on a time in <code>GMT</code>), while
<code>java.sql.Date</code> will format dates based on the client's local
time zone. Please note that this <code>DATE</code> type is different than the
<code>DATE</code> type as defined by the SQL 92 standard in that it includes a
time component. As such, it is not in compliance with the <code>JDBC
APIs</code>. As the underlying data is still stored as a long, only the
presentation of the value is incorre
ct.</p>
<p>Example:</p>
<p class="notranslate">DATE</p>
Modified: phoenix/site/publish/language/functions.html
URL:
http://svn.apache.org/viewvc/phoenix/site/publish/language/functions.html?rev=1758811&r1=1758810&r2=1758811&view=diff
==============================================================================
--- phoenix/site/publish/language/functions.html (original)
+++ phoenix/site/publish/language/functions.html Thu Sep 1 17:01:49 2016
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2016-08-19
+ Generated by Apache Maven Doxia at 2016-09-01
Rendered using Reflow Maven Skin 1.1.0
(http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
@@ -1541,7 +1541,7 @@ TO_DATE( <a href="index.html#term">strin
TO_DATE( <a href="index.html#term">stringTerm</a> [, <a
href="index.html#string">formatString</a> [, <a
href="index.html#string">timeZoneIdString</a>]] )
</pre>
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.</p>
+<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.</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')</p>
@@ -1559,7 +1559,7 @@ CURRENT_DATE()
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.</p>
+<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>
@@ -1577,7 +1577,7 @@ CURRENT_TIME()
CURRENT_TIME()
</pre>
syntax-end -->
-<p>Same as <code>CURRENT_DATE</code>(), except returns a value of type
<code>TIME</code>. In either case, the underlying representation is the epoch
time as a long value.</p>
+<p>Same as <code>CURRENT_DATE</code>(), except returns a value of type
<code>TIME</code>. In either case, the underlying representation is the epoch
time as a long value. Please see the Data Type reference guide about how Apache
Phoenix presently defines the <code>TIME</code> datatype.</p>
<p>Example:</p>
<p class="notranslate">CURRENT_TIME()</p>
Modified: phoenix/site/publish/language/index.html
URL:
http://svn.apache.org/viewvc/phoenix/site/publish/language/index.html?rev=1758811&r1=1758810&r2=1758811&view=diff
==============================================================================
--- phoenix/site/publish/language/index.html (original)
+++ phoenix/site/publish/language/index.html Thu Sep 1 17:01:49 2016
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2016-08-19
+ Generated by Apache Maven Doxia at 2016-09-01
Rendered using Reflow Maven Skin 1.1.0
(http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
