[KYUUBI #700] Add class description for DataGenerator

<!--
Thanks for sending a pull request!

Here are some tips for you:
  1. If this is your first time, please read our contributor guidelines: https://kyuubi.readthedocs.io/en/latest/community/contributions.html
  2. If the PR is related to an issue in https://github.com/NetEase/kyuubi/issues, add '[KYUUBI #XXXX]' in your PR title, e.g., '[KYUUBI #XXXX] Your PR title ...'.
  3. If the PR is unfinished, add '[WIP]' in your PR title, e.g., '[WIP][KYUUBI #XXXX] Your PR title ...'.
-->

### _Why are the changes needed?_
<!--
Please clarify why the changes are needed. For instance,
  1. If you add a feature, you can talk about the use case of it.
  2. If you fix a bug, you can clarify why it is a bug.
-->
Add usage description so we can use this tpcds data generator easily.

### _How was this patch tested?_
Not need.

Closes #700 from ulysses-you/class-description.

Closes #700

2e3d5945 [ulysses-you] *
b2aea77e [ulysses-you] desc

Authored-by: ulysses-you <ulyssesyou18@gmail.com>
Signed-off-by: Cheng Pan <379377944@qq.com>
This commit is contained in:
ulysses-you 2021-06-17 19:33:24 +08:00 committed by Cheng Pan
parent f0ffe3e06d
commit cd32e4aeb6

View File

@ -21,6 +21,13 @@ import org.apache.spark.SparkConf
import org.apache.spark.sql.SparkSession
import org.slf4j.LoggerFactory
// scalastyle:off line.size.limit
/**
* Usage:
* If you want to generate 10GB data with new database `tpcds_sf10`, you can run the cmd:
* `$SPARK_HOME/bin/spark-submit --conf spark.sql.tpcds.scale.factor=10 --conf spark.sql.tpcds.database=tpcds_sf10 --class org.apache.kyuubi.tpcds.DataGenerator kyuubi-tpcds-*.jar`
*/
// scalastyle:on line.size.limit
object DataGenerator {
private val logger =
LoggerFactory.getLogger(this.getClass.getSimpleName.stripSuffix("$"))