Skip to content

[SPARK-23238][SQL] Externalize SQLConf configurations exposed in documentation #20403

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
HyukjinKwon wants to merge 4 commits into from
Closed

[SPARK-23238][SQL] Externalize SQLConf configurations exposed in documentation #20403

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4899e33
Minor doc correction for 'spark.sql.execution.arrow.enabled'
HyukjinKwon Jan 26, 2018
1f4d288
Address comments
HyukjinKwon Jan 26, 2018
0c05526
Externalize few more configurations mentioned in the documentation
HyukjinKwon Jan 28, 2018
fd7f5c0
Take out 'spark.sql.execution.arrow.maxRecordsPerBatch' for now
HyukjinKwon Jan 29, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 5 additions & 8 deletions sql/catalyst/src/main/scala/org/apache/spark/sql/internal/SQLConf.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,14 +123,12 @@ object SQLConf {
.createWithDefault(10)

val COMPRESS_CACHED = buildConf("spark.sql.inMemoryColumnarStorage.compressed")
.internal()
.doc("When set to true Spark SQL will automatically select a compression codec for each " +
"column based on statistics of the data.")
.booleanConf
.createWithDefault(true)

val COLUMN_BATCH_SIZE = buildConf("spark.sql.inMemoryColumnarStorage.batchSize")
.internal()
.doc("Controls the size of batches for columnar caching. Larger batch sizes can improve " +
"memory utilization and compression, but risk OOMs when caching data.")
.intConf
Expand Down Expand Up @@ -1043,17 +1041,16 @@ object SQLConf {

val ARROW_EXECUTION_ENABLE =
buildConf("spark.sql.execution.arrow.enabled")
.internal()
.doc("Make use of Apache Arrow for columnar data transfers. Currently available " +
"for use with pyspark.sql.DataFrame.toPandas with the following data types: " +
"StringType, BinaryType, BooleanType, DoubleType, FloatType, ByteType, IntegerType, " +
"LongType, ShortType")
.doc("When true, make use of Apache Arrow for columnar data transfers. Currently available " +
"for use with pyspark.sql.DataFrame.toPandas, and " +
"pyspark.sql.SparkSession.createDataFrame when its input is a Pandas DataFrame. " +
"The following data types are unsupported: " +
"MapType, ArrayType of TimestampType, and nested StructType.")
.booleanConf
.createWithDefault(false)
Copy link
Member

@viirya viirya Jan 28, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

spark.sql.execution.arrow.maxRecordsPerBatch is also mentioned in the doc change at #19575. Shall we also externalize it?

Copy link
Member Author

@HyukjinKwon HyukjinKwon Jan 28, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yup. Let me update spark.sql.inMemoryColumnarStorage.compressed and spark.sql.inMemoryColumnarStorage.batchSize too. These are also exposed but internals.


val ARROW_EXECUTION_MAX_RECORDS_PER_BATCH =
buildConf("spark.sql.execution.arrow.maxRecordsPerBatch")
.internal()
Copy link
Member

@gatorsmile gatorsmile Jan 29, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure about conf. https://github.com/apache/spark/pull/19575/files#r164252424

If we want to merge this PR now, maybe revert this change?

Copy link
Member

@gatorsmile gatorsmile Jan 29, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can externalize this conf in that PR #19575, if we believe this conf is the one we will use in the long term.

Copy link
Member Author

@HyukjinKwon HyukjinKwon Jan 29, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense. Let me take this out. Is this only one you are concerned of for now?

.doc("When using Apache Arrow, limit the maximum number of records that can be written " +
"to a single ArrowRecordBatch in memory. If set to zero or negative there is no limit.")
.intConf
Expand Down