Merge pull request #875 from katzyn/docs

Improve date-time related parts of documentation

h2/src/docsrc/help/help.csv

@@ -2300,9 +2300,9 @@ Each table has a pseudo-column named ""_ROWID_"" that contains the unique row id
 "
 
 "Other Grammar","Time","
-TIME 'hh:mm:ss'
+TIME 'hh:mm:ss[.nnnnnnnnn]'
 ","
-A time literal. A value is between plus and minus 2 million hours
+A time literal. A value is between 0:00:00 and 23:59:59.999999999
 and has nanosecond resolution.
 ","
 TIME '23:59:59'
@@ -2318,6 +2318,19 @@ minimum and maximum years are 0001 and 9999.
 TIMESTAMP '2005-12-31 23:59:59'
 "
 
+"Other Grammar","Timestamp with time zone","
+TIMESTAMP 'yyyy-MM-dd hh:mm:ss[.nnnnnnnnn]
+[Z | { - | + } timeZoneOffsetString | timeZoneNameString ]'
+","
+A timestamp with time zone literal.
+If name of time zone is specified it will be converted to time zone offset.
+","
+TIMESTAMP WITH TIME ZONE '2005-12-31 23:59:59Z'
+TIMESTAMP WITH TIME ZONE '2005-12-31 23:59:59-10:00'
+TIMESTAMP WITH TIME ZONE '2005-12-31 23:59:59.123+05'
+TIMESTAMP WITH TIME ZONE '2005-12-31 23:59:59.123456789 Europe/London'
+"
+
 "Other Grammar","Value","
 string | dollarQuotedString | numeric | date | time | timestamp | boolean | bytes | array | null
 ","
@@ -3671,7 +3684,7 @@ CURRENT_TIMESTAMP()
 Adds units to a date-time value. The string indicates the unit.
 Use negative values to subtract units.
 addIntLong may be a long value when manipulating milliseconds,
-otherwise it's range is restricted to int.
+microseconds, or nanoseconds otherwise its range is restricted to int.
 The same units as in the EXTRACT function are supported.
 This method returns a value with the same type as specified value if unit is compatible with this value.
 If specified unit is a HOUR, MINUTE, SECOND, MILLISECOND, etc and value is a DATE value DATEADD returns combined TIMESTAMP.
@@ -3732,7 +3745,8 @@ EXTRACT ( { YEAR | YY | MONTH | MM | QUARTER | WEEK | ISO_WEEK
     FROM timestamp )
 ","
 Returns a specific value from a timestamps.
-This method returns an int.
+This method returns a numeric value with EPOCH unit and
+an int for all other time units.
 ","
 EXTRACT(SECOND FROM CURRENT_TIMESTAMP)
 "
@@ -3821,6 +3835,17 @@ This method uses the current system locale.
 WEEK(CREATED)
 "
 
+"Functions (Time and Date)","ISO_WEEK","
+ISO_WEEK(timestamp)
+","
+Returns the week (1-53) from a timestamp.
+This method uses the ISO definition when
+first week of year should have at least four days
+and week is started with Monday.
+","
+ISO_WEEK(CREATED)
+"
+
 "Functions (Time and Date)","YEAR","
 YEAR(timestamp)
 ","
@@ -3829,6 +3854,14 @@ Returns the year from a timestamp.
 YEAR(CREATED)
 "
 
+"Functions (Time and Date)","ISO_YEAR","
+ISO_YEAR(timestamp)
+","
+Returns the ISO week year from a timestamp.
+","
+ISO_YEAR(CREATED)
+"
+
 "Functions (System)","ARRAY_GET","
 ARRAY_GET(arrayExpression, indexExpression)
 ","

h2/src/main/org/h2/expression/Function.java

@@ -1525,27 +1525,30 @@ public class Function extends Expression implements FunctionCall {
 
                 } else if (v1 instanceof ValueDate) {
 
-                    // Case where the value is of type date '2000:01:01', we have to retrieve the total 
-                    // number of days and multiply it by the number of seconds in a day.
+                    // Case where the value is of type date '2000:01:01', we have to retrieve the
+                    // total number of days and multiply it by the number of seconds in a day.
                     result = ValueDecimal.get(numberOfDays.multiply(secondsPerDay));
 
                 } else if (v1 instanceof ValueTimestampTimeZone) {
 
-                    // Case where the value is a of type ValueTimestampTimeZone ('2000:01:01 10:00:00+05).
-                    // We retrieve the time zone offset in minute
+                    // Case where the value is a of type ValueTimestampTimeZone
+                    // ('2000:01:01 10:00:00+05').
+                    // We retrieve the time zone offset in minutes
                     ValueTimestampTimeZone v = (ValueTimestampTimeZone) v1;
                     BigDecimal timeZoneOffsetSeconds = new BigDecimal(v.getTimeZoneOffsetMins() * 60);
                     // Sum the time in nanoseconds and the total number of days in seconds
                     // and adding the timeZone offset in seconds.
                     result = ValueDecimal.get(timeNanosBigDecimal.divide(nanosSeconds)
-                            .add(numberOfDays.multiply(secondsPerDay))
-                            .subtract(timeZoneOffsetSeconds));
+                            .add(numberOfDays.multiply(secondsPerDay)).subtract(timeZoneOffsetSeconds));
 
                 } else {
 
-                    // By default, we have the date and the time ('2000:01:01 10:00:00) if no type is given. 
-                    // We just have to sum the time in nanoseconds and the total number of days in seconds.
-                    result = ValueDecimal.get(timeNanosBigDecimal.divide(nanosSeconds).add(numberOfDays.multiply(secondsPerDay)));
+                    // By default, we have the date and the time ('2000:01:01 10:00:00') if no type
+                    // is given.
+                    // We just have to sum the time in nanoseconds and the total number of days in
+                    // seconds.
+                    result = ValueDecimal
+                            .get(timeNanosBigDecimal.divide(nanosSeconds).add(numberOfDays.multiply(secondsPerDay)));
                 }
             }
             break;

h2/src/main/org/h2/tools/ChangeFileEncryption.java

@@ -224,7 +224,8 @@ public class ChangeFileEncryption extends Tool {
         try (FileChannel fileIn = getFileChannel(fileName, "r", decryptKey)){
             try(InputStream inStream = new FileChannelInputStream(fileIn, true)) {
                 FileUtils.delete(temp);
-                try (OutputStream outStream = new FileChannelOutputStream(getFileChannel(temp, "rw", encryptKey), true)) {
+                try (OutputStream outStream = new FileChannelOutputStream(getFileChannel(temp, "rw", encryptKey),
+                        true)) {
                     byte[] buffer = new byte[4 * 1024];
                     long remaining = fileIn.size();
                     long total = remaining;

h2/src/tools/org/h2/build/doc/dictionary.txt

@@ -764,5 +764,5 @@ mdy destfile hclf forbids spellchecking selfdestruct expects accident jacocoagen
 jacoco xdata invokes sourcefiles classfiles duplication crypto stacktraces prt directions handled overly asm hardcoded
 interpolated thead
 
-die weekdiff osx subprocess dow proleptic
-
+die weekdiff osx subprocess dow proleptic microsecond microseconds divisible cmp denormalized suppressed saturated mcs
+london