-
Notifications
You must be signed in to change notification settings - Fork 29k
[MINOR][SQL][DOCS] Improve unix_timestamp's scaladoc (and typo hunting) #17801
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 2 commits
20edec8
c3cc96b
742fbb4
5326ad1
1079b7d
581e8e4
c96f137
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2491,10 +2491,10 @@ object functions { | |
| * Converts a date/timestamp/string to a value of string in the format specified by the date | ||
| * format given by the second argument. | ||
| * | ||
| * A pattern could be for instance `dd.MM.yyyy` and could return a string like '18.03.1993'. All | ||
| * pattern letters of `java.text.SimpleDateFormat` can be used. | ||
| * A pattern `dd.MM.yyyy` would return a string like `18.03.1993`. | ||
| * All pattern letters of `java.text.SimpleDateFormat` can be used. | ||
| * | ||
| * @note Use when ever possible specialized functions like [[year]]. These benefit from a | ||
| * @note Use specialized functions like [[year]] whenever possible as they benefit from a | ||
| * specialized implementation. | ||
| * | ||
| * @group datetime_funcs | ||
|
|
@@ -2647,7 +2647,11 @@ object functions { | |
| } | ||
|
|
||
| /** | ||
| * Gets current Unix timestamp in seconds. | ||
| * Returns the current Unix timestamp (in seconds). | ||
| * | ||
| * NOTE: All calls of `unix_timestamp` within the same query return the same value | ||
| * (i.e. the current timestamp is calculated at the start of query evaluation). | ||
| * | ||
| * @group datetime_funcs | ||
| * @since 1.5.0 | ||
| */ | ||
|
|
@@ -2657,22 +2661,27 @@ object functions { | |
|
|
||
| /** | ||
| * Converts time string in format yyyy-MM-dd HH:mm:ss to Unix timestamp (in seconds), | ||
| * using the default timezone and the default locale, return null if fail. | ||
| * using the default timezone and the default locale. | ||
| * Returns `null` if fails. | ||
| * | ||
| * @group datetime_funcs | ||
| * @since 1.5.0 | ||
| */ | ||
| def unix_timestamp(s: Column): Column = withExpr { | ||
| UnixTimestamp(s.expr, Literal("yyyy-MM-dd HH:mm:ss")) | ||
| } | ||
|
|
||
| // scalastyle:off line.size.limit | ||
| /** | ||
| * Convert time string with given pattern | ||
| * (see [http://docs.oracle.com/javase/tutorial/i18n/format/simpleDateFormat.html]) | ||
| * to Unix time stamp (in seconds), return null if fail. | ||
| * Converts time string with given pattern to Unix timestamp (in seconds). | ||
| * Returns `null` if fails. | ||
| * | ||
| * @see [[http://docs.oracle.com/javase/tutorial/i18n/format/simpleDateFormat.html Customizing Formats]] | ||
|
||
| * @group datetime_funcs | ||
| * @since 1.5.0 | ||
| */ | ||
| def unix_timestamp(s: Column, p: String): Column = withExpr {UnixTimestamp(s.expr, Literal(p)) } | ||
| // scalastyle:on | ||
| def unix_timestamp(s: Column, p: String): Column = withExpr { UnixTimestamp(s.expr, Literal(p)) } | ||
|
|
||
| /** | ||
| * Convert time string to a Unix timestamp (in seconds). | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we use
@noteand fix the corresponding contents in Python and R if applicable?