Repository: spark Updated Branches: refs/heads/master 1d1a09be9 -> 1270e7175
[SPARK-22086][DOCS] Add expression description for CASE WHEN ## What changes were proposed in this pull request? In SQL conditional expressions, only CASE WHEN lacks for expression description. This patch fills the gap. ## How was this patch tested? Only documentation change. Author: Liang-Chi Hsieh <vii...@gmail.com> Closes #19304 from viirya/casewhen-doc. Project: http://git-wip-us.apache.org/repos/asf/spark/repo Commit: http://git-wip-us.apache.org/repos/asf/spark/commit/1270e717 Tree: http://git-wip-us.apache.org/repos/asf/spark/tree/1270e717 Diff: http://git-wip-us.apache.org/repos/asf/spark/diff/1270e717 Branch: refs/heads/master Commit: 1270e71753f40c353fb726a0a3d373d181aedb40 Parents: 1d1a09b Author: Liang-Chi Hsieh <vii...@gmail.com> Authored: Thu Sep 21 22:45:06 2017 +0900 Committer: hyukjinkwon <gurwls...@gmail.com> Committed: Thu Sep 21 22:45:06 2017 +0900 ---------------------------------------------------------------------- .../expressions/conditionalExpressions.scala | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/spark/blob/1270e717/sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/conditionalExpressions.scala ---------------------------------------------------------------------- diff --git a/sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/conditionalExpressions.scala b/sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/conditionalExpressions.scala index b59b6de..d95b59d 100644 --- a/sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/conditionalExpressions.scala +++ b/sql/catalyst/src/main/scala/org/apache/spark/sql/catalyst/expressions/conditionalExpressions.scala @@ -223,7 +223,22 @@ abstract class CaseWhenBase( */ // scalastyle:off line.size.limit @ExpressionDescription( - usage = "CASE WHEN expr1 THEN expr2 [WHEN expr3 THEN expr4]* [ELSE expr5] END - When `expr1` = true, returns `expr2`; when `expr3` = true, return `expr4`; else return `expr5`.") + usage = "CASE WHEN expr1 THEN expr2 [WHEN expr3 THEN expr4]* [ELSE expr5] END - When `expr1` = true, returns `expr2`; else when `expr3` = true, returns `expr4`; else returns `expr5`.", + arguments = """ + Arguments: + * expr1, expr3 - the branch condition expressions should all be boolean type. + * expr2, expr4, expr5 - the branch value expressions and else value expression should all be + same type or coercible to a common type. + """, + examples = """ + Examples: + > SELECT CASE WHEN 1 > 0 THEN 1 WHEN 2 > 0 THEN 2.0 ELSE 1.2 END; + 1 + > SELECT CASE WHEN 1 < 0 THEN 1 WHEN 2 > 0 THEN 2.0 ELSE 1.2 END; + 2 + > SELECT CASE WHEN 1 < 0 THEN 1 WHEN 2 < 0 THEN 2.0 ELSE null END; + NULL + """) // scalastyle:on line.size.limit case class CaseWhen( val branches: Seq[(Expression, Expression)], --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@spark.apache.org For additional commands, e-mail: commits-h...@spark.apache.org
