ODIn/spark-instrumented-optimizer
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

[MINOR][DOC] Fix the CalendarIntervalType description

Browse source 
### What changes were proposed in this pull request?

fix the overdue and incorrect description about CalendarIntervalType

### Why are the changes needed?

api doc correctness

### Does this PR introduce any user-facing change?

no
### How was this patch tested?

no

Closes #26659 from yaooqinn/intervaldoc.

Authored-by: Kent Yao <yaooqinn@hotmail.com>
Signed-off-by: Wenchen Fan <wenchen@databricks.com>
This commit is contained in:
Kent Yao 2019-11-26 12:49:56 +08:00 committed by Wenchen Fan
parent 53e19f3678
commit 8b0121bea8
1 changed files with 7 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
sql/catalyst/src/main/scala/org/apache/spark/sql/types/CalendarIntervalType.scala
View file

@ -21,12 +21,15 @@ import org.apache.spark.annotation.Stable
import org.apache.spark.unsafe.types.CalendarInterval
/**
* The data type representing calendar time intervals. The calendar time interval is stored
* internally in two components: number of months the number of microseconds.
* The data type representing calendar intervals. The calendar interval is stored internally in
* three components:
* an integer value representing the number of `months` in this interval,
* an integer value representing the number of `days` in this interval,
* a long value representing the number of `microseconds` in this interval.
*
* Please use the singleton `DataTypes.CalendarIntervalType`.
* Please use the singleton `DataTypes.CalendarIntervalType` to refer the type.
*
* @note Calendar intervals are not comparable.
* @note Calendar intervals support comparison and ordering since 3.0.0.
*
* @since 1.5.0
*/