Skip to content

Commit 34ebcc6

Browse files
rxingatorsmile
authored andcommitted
[MINOR] Improve documentation for HiveStringType's
The diff should be self-explanatory. Author: Reynold Xin <[email protected]> Closes apache#21897 from rxin/hivestringtypedoc.
1 parent 10f1f19 commit 34ebcc6

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

sql/catalyst/src/main/scala/org/apache/spark/sql/types/HiveStringType.scala

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,14 +56,18 @@ object HiveStringType {
5656
}
5757

5858
/**
59-
* Hive char type.
59+
* Hive char type. Similar to other HiveStringType's, these datatypes should only used for
60+
* parsing, and should NOT be used anywhere else. Any instance of these data types should be
61+
* replaced by a [[StringType]] before analysis.
6062
*/
6163
case class CharType(length: Int) extends HiveStringType {
6264
override def simpleString: String = s"char($length)"
6365
}
6466

6567
/**
66-
* Hive varchar type.
68+
* Hive varchar type. Similar to other HiveStringType's, these datatypes should only used for
69+
* parsing, and should NOT be used anywhere else. Any instance of these data types should be
70+
* replaced by a [[StringType]] before analysis.
6771
*/
6872
case class VarcharType(length: Int) extends HiveStringType {
6973
override def simpleString: String = s"varchar($length)"

0 commit comments

Comments
 (0)