From 1a200a3eea9257677baf9c1c66311b5efd6c80fe Mon Sep 17 00:00:00 2001 From: scwf Date: Sun, 18 Jan 2015 11:03:13 -0800 Subject: [PATCH] [SQL][Minor] Update sql doc according to data type APIs changes Follow up of #3925 /cc rxin Author: scwf Closes #4095 from scwf/sql-doc and squashes the following commits: 97e311b [scwf] update sql doc since now expose only one version of the data type APIs --- docs/sql-programming-guide.md | 41 ++++++++++++++++++----------------- 1 file changed, 21 insertions(+), 20 deletions(-) diff --git a/docs/sql-programming-guide.md b/docs/sql-programming-guide.md index 729045b81a8c0..be8c5c2c1522e 100644 --- a/docs/sql-programming-guide.md +++ b/docs/sql-programming-guide.md @@ -1333,9 +1333,9 @@ import org.apache.spark.sql._
All data types of Spark SQL are located in the package of -`org.apache.spark.sql.api.java`. To access or create a data type, +`org.apache.spark.sql.types`. To access or create a data type, please use factory methods provided in -`org.apache.spark.sql.api.java.DataType`. +`org.apache.spark.sql.types.DataTypes`. @@ -1346,109 +1346,110 @@ please use factory methods provided in @@ -1458,7 +1459,7 @@ please use factory methods provided in
ByteType byte or Byte - DataType.ByteType + DataTypes.ByteType
ShortType short or Short - DataType.ShortType + DataTypes.ShortType
IntegerType int or Integer - DataType.IntegerType + DataTypes.IntegerType
LongType long or Long - DataType.LongType + DataTypes.LongType
FloatType float or Float - DataType.FloatType + DataTypes.FloatType
DoubleType double or Double - DataType.DoubleType + DataTypes.DoubleType
DecimalType java.math.BigDecimal - DataType.DecimalType + DataTypes.createDecimalType()
+ DataTypes.createDecimalType(precision, scale).
StringType String - DataType.StringType + DataTypes.StringType
BinaryType byte[] - DataType.BinaryType + DataTypes.BinaryType
BooleanType boolean or Boolean - DataType.BooleanType + DataTypes.BooleanType
TimestampType java.sql.Timestamp - DataType.TimestampType + DataTypes.TimestampType
DateType java.sql.Date - DataType.DateType + DataTypes.DateType
ArrayType java.util.List - DataType.createArrayType(elementType)
+ DataTypes.createArrayType(elementType)
Note: The value of containsNull will be true
- DataType.createArrayType(elementType, containsNull). + DataTypes.createArrayType(elementType, containsNull).
MapType java.util.Map - DataType.createMapType(keyType, valueType)
+ DataTypes.createMapType(keyType, valueType)
Note: The value of valueContainsNull will be true.
- DataType.createMapType(keyType, valueType, valueContainsNull)
+ DataTypes.createMapType(keyType, valueType, valueContainsNull)
StructType org.apache.spark.sql.api.java.Row - DataType.createStructType(fields)
+ DataTypes.createStructType(fields)
Note: fields is a List or an array of StructFields. Also, two fields with the same name are not allowed.
The value type in Java of the data type of this field (For example, int for a StructField with the data type IntegerType) - DataType.createStructField(name, dataType, nullable) + DataTypes.createStructField(name, dataType, nullable)