Skip to content

Commit 1a200a3

Browse files
scwfrxin
authored andcommitted
[SQL][Minor] Update sql doc according to data type APIs changes
Follow up of apache#3925 /cc rxin Author: scwf <[email protected]> Closes apache#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
1 parent 1727e08 commit 1a200a3

File tree

1 file changed

+21
-20
lines changed

1 file changed

+21
-20
lines changed

docs/sql-programming-guide.md

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1333,9 +1333,9 @@ import org.apache.spark.sql._
13331333
<div data-lang="java" markdown="1">
13341334

13351335
All data types of Spark SQL are located in the package of
1336-
`org.apache.spark.sql.api.java`. To access or create a data type,
1336+
`org.apache.spark.sql.types`. To access or create a data type,
13371337
please use factory methods provided in
1338-
`org.apache.spark.sql.api.java.DataType`.
1338+
`org.apache.spark.sql.types.DataTypes`.
13391339

13401340
<table class="table">
13411341
<tr>
@@ -1346,109 +1346,110 @@ please use factory methods provided in
13461346
<td> <b>ByteType</b> </td>
13471347
<td> byte or Byte </td>
13481348
<td>
1349-
DataType.ByteType
1349+
DataTypes.ByteType
13501350
</td>
13511351
</tr>
13521352
<tr>
13531353
<td> <b>ShortType</b> </td>
13541354
<td> short or Short </td>
13551355
<td>
1356-
DataType.ShortType
1356+
DataTypes.ShortType
13571357
</td>
13581358
</tr>
13591359
<tr>
13601360
<td> <b>IntegerType</b> </td>
13611361
<td> int or Integer </td>
13621362
<td>
1363-
DataType.IntegerType
1363+
DataTypes.IntegerType
13641364
</td>
13651365
</tr>
13661366
<tr>
13671367
<td> <b>LongType</b> </td>
13681368
<td> long or Long </td>
13691369
<td>
1370-
DataType.LongType
1370+
DataTypes.LongType
13711371
</td>
13721372
</tr>
13731373
<tr>
13741374
<td> <b>FloatType</b> </td>
13751375
<td> float or Float </td>
13761376
<td>
1377-
DataType.FloatType
1377+
DataTypes.FloatType
13781378
</td>
13791379
</tr>
13801380
<tr>
13811381
<td> <b>DoubleType</b> </td>
13821382
<td> double or Double </td>
13831383
<td>
1384-
DataType.DoubleType
1384+
DataTypes.DoubleType
13851385
</td>
13861386
</tr>
13871387
<tr>
13881388
<td> <b>DecimalType</b> </td>
13891389
<td> java.math.BigDecimal </td>
13901390
<td>
1391-
DataType.DecimalType
1391+
DataTypes.createDecimalType()<br />
1392+
DataTypes.createDecimalType(<i>precision</i>, <i>scale</i>).
13921393
</td>
13931394
</tr>
13941395
<tr>
13951396
<td> <b>StringType</b> </td>
13961397
<td> String </td>
13971398
<td>
1398-
DataType.StringType
1399+
DataTypes.StringType
13991400
</td>
14001401
</tr>
14011402
<tr>
14021403
<td> <b>BinaryType</b> </td>
14031404
<td> byte[] </td>
14041405
<td>
1405-
DataType.BinaryType
1406+
DataTypes.BinaryType
14061407
</td>
14071408
</tr>
14081409
<tr>
14091410
<td> <b>BooleanType</b> </td>
14101411
<td> boolean or Boolean </td>
14111412
<td>
1412-
DataType.BooleanType
1413+
DataTypes.BooleanType
14131414
</td>
14141415
</tr>
14151416
<tr>
14161417
<td> <b>TimestampType</b> </td>
14171418
<td> java.sql.Timestamp </td>
14181419
<td>
1419-
DataType.TimestampType
1420+
DataTypes.TimestampType
14201421
</td>
14211422
</tr>
14221423
<tr>
14231424
<td> <b>DateType</b> </td>
14241425
<td> java.sql.Date </td>
14251426
<td>
1426-
DataType.DateType
1427+
DataTypes.DateType
14271428
</td>
14281429
</tr>
14291430
<tr>
14301431
<td> <b>ArrayType</b> </td>
14311432
<td> java.util.List </td>
14321433
<td>
1433-
DataType.createArrayType(<i>elementType</i>)<br />
1434+
DataTypes.createArrayType(<i>elementType</i>)<br />
14341435
<b>Note:</b> The value of <i>containsNull</i> will be <i>true</i><br />
1435-
DataType.createArrayType(<i>elementType</i>, <i>containsNull</i>).
1436+
DataTypes.createArrayType(<i>elementType</i>, <i>containsNull</i>).
14361437
</td>
14371438
</tr>
14381439
<tr>
14391440
<td> <b>MapType</b> </td>
14401441
<td> java.util.Map </td>
14411442
<td>
1442-
DataType.createMapType(<i>keyType</i>, <i>valueType</i>)<br />
1443+
DataTypes.createMapType(<i>keyType</i>, <i>valueType</i>)<br />
14431444
<b>Note:</b> The value of <i>valueContainsNull</i> will be <i>true</i>.<br />
1444-
DataType.createMapType(<i>keyType</i>, <i>valueType</i>, <i>valueContainsNull</i>)<br />
1445+
DataTypes.createMapType(<i>keyType</i>, <i>valueType</i>, <i>valueContainsNull</i>)<br />
14451446
</td>
14461447
</tr>
14471448
<tr>
14481449
<td> <b>StructType</b> </td>
14491450
<td> org.apache.spark.sql.api.java.Row </td>
14501451
<td>
1451-
DataType.createStructType(<i>fields</i>)<br />
1452+
DataTypes.createStructType(<i>fields</i>)<br />
14521453
<b>Note:</b> <i>fields</i> is a List or an array of StructFields.
14531454
Also, two fields with the same name are not allowed.
14541455
</td>
@@ -1458,7 +1459,7 @@ please use factory methods provided in
14581459
<td> The value type in Java of the data type of this field
14591460
(For example, int for a StructField with the data type IntegerType) </td>
14601461
<td>
1461-
DataType.createStructField(<i>name</i>, <i>dataType</i>, <i>nullable</i>)
1462+
DataTypes.createStructField(<i>name</i>, <i>dataType</i>, <i>nullable</i>)
14621463
</td>
14631464
</tr>
14641465
</table>

0 commit comments

Comments
 (0)