Skip to content

[SPARK-55798][SQL] Propagate config data type into config builders #54579

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
dtenedor wants to merge 1 commit into from
+265 −29
Closed

[SPARK-55798][SQL] Propagate config data type into config builders #54579

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
44 changes: 25 additions & 19 deletions common/utils/src/main/scala/org/apache/spark/internal/config/ConfigBuilder.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,17 +150,18 @@ private object ConfigHelpers {
private[spark] class TypedConfigBuilder[T](
val parent: ConfigBuilder,
val converter: String => T,
val stringConverter: T => String) {
val stringConverter: T => String,
val configEntryType: ConfigEntryType) {

import ConfigHelpers._

def this(parent: ConfigBuilder, converter: String => T) = {
this(parent, converter, { v: T => v.toString })
def this(parent: ConfigBuilder, converter: String => T, configEntryType: ConfigEntryType) = {
this(parent, converter, { v: T => v.toString }, configEntryType)
}

/** Apply a transformation to the user-provided values of the config entry. */
def transform(fn: T => T): TypedConfigBuilder[T] = {
new TypedConfigBuilder(parent, s => fn(converter(s)), stringConverter)
new TypedConfigBuilder(parent, s => fn(converter(s)), stringConverter, configEntryType)
}

/** Checks if the user-provided value for the config matches the validator. */
Expand Down Expand Up @@ -204,14 +205,15 @@ private[spark] class TypedConfigBuilder[T](

/** Turns the config entry into a sequence of values of the underlying type. */
def toSequence: TypedConfigBuilder[Seq[T]] = {
new TypedConfigBuilder(parent, stringToSeq(_, converter), seqToString(_, stringConverter))
new TypedConfigBuilder(parent, stringToSeq(_, converter), seqToString(_, stringConverter),
configEntryType)
}

/** Creates a [[ConfigEntry]] that does not have a default value. */
def createOptional: OptionalConfigEntry[T] = {
val entry = new OptionalConfigEntry[T](parent.key, parent._prependedKey,
parent._prependSeparator, parent._alternatives, converter, stringConverter, parent._doc,
parent._public, parent._version)
parent._public, parent._version, configEntryType)
parent._onCreate.foreach(_(entry))
entry
}
Expand All @@ -227,7 +229,7 @@ private[spark] class TypedConfigBuilder[T](
val transformedDefault = converter(stringConverter(default))
val entry = new ConfigEntryWithDefault[T](parent.key, parent._prependedKey,
parent._prependSeparator, parent._alternatives, transformedDefault, converter,
stringConverter, parent._doc, parent._public, parent._version)
stringConverter, parent._doc, parent._public, parent._version, configEntryType)
parent._onCreate.foreach(_ (entry))
entry
}
Expand All @@ -237,7 +239,7 @@ private[spark] class TypedConfigBuilder[T](
def createWithDefaultFunction(defaultFunc: () => T): ConfigEntry[T] = {
val entry = new ConfigEntryWithDefaultFunction[T](parent.key, parent._prependedKey,
parent._prependSeparator, parent._alternatives, defaultFunc, converter, stringConverter,
parent._doc, parent._public, parent._version)
parent._doc, parent._public, parent._version, configEntryType)
parent._onCreate.foreach(_ (entry))
entry
}
Expand All @@ -249,7 +251,7 @@ private[spark] class TypedConfigBuilder[T](
def createWithDefaultString(default: String): ConfigEntry[T] = {
val entry = new ConfigEntryWithDefaultString[T](parent.key, parent._prependedKey,
parent._prependSeparator, parent._alternatives, default, converter, stringConverter,
parent._doc, parent._public, parent._version)
parent._doc, parent._public, parent._version, configEntryType)
parent._onCreate.foreach(_(entry))
entry
}
Expand Down Expand Up @@ -310,46 +312,49 @@ private[spark] case class ConfigBuilder(key: String) {

def intConf: TypedConfigBuilder[Int] = {
checkPrependConfig
new TypedConfigBuilder(this, toNumber(_, _.toInt, key, "int"))
new TypedConfigBuilder(this, toNumber(_, _.toInt, key, "int"), ConfigEntryType.IntEntry)
}

def longConf: TypedConfigBuilder[Long] = {
checkPrependConfig
new TypedConfigBuilder(this, toNumber(_, _.toLong, key, "long"))
new TypedConfigBuilder(this, toNumber(_, _.toLong, key, "long"), ConfigEntryType.LongEntry)
}

def doubleConf: TypedConfigBuilder[Double] = {
checkPrependConfig
new TypedConfigBuilder(this, toNumber(_, _.toDouble, key, "double"))
new TypedConfigBuilder(this, toNumber(_, _.toDouble, key, "double"),
ConfigEntryType.DoubleEntry)
}

def booleanConf: TypedConfigBuilder[Boolean] = {
checkPrependConfig
new TypedConfigBuilder(this, toBoolean(_, key))
new TypedConfigBuilder(this, toBoolean(_, key), ConfigEntryType.BooleanEntry)
}

def stringConf: TypedConfigBuilder[String] = {
new TypedConfigBuilder(this, v => v)
new TypedConfigBuilder(this, v => v, ConfigEntryType.StringEntry)
}

def enumConf(e: Enumeration): TypedConfigBuilder[e.Value] = {
checkPrependConfig
new TypedConfigBuilder(this, toEnum(_, e, key))
new TypedConfigBuilder(this, toEnum(_, e, key), ConfigEntryType.EnumEntry)
}

def enumConf[E <: Enum[E]](e: Class[E]): TypedConfigBuilder[E] = {
checkPrependConfig
new TypedConfigBuilder(this, toEnum(_, e, key))
new TypedConfigBuilder(this, toEnum(_, e, key), ConfigEntryType.EnumEntry)
}

def timeConf(unit: TimeUnit): TypedConfigBuilder[Long] = {
checkPrependConfig
new TypedConfigBuilder(this, timeFromString(_, unit, key), timeToString(_, unit))
new TypedConfigBuilder(this, timeFromString(_, unit, key), timeToString(_, unit),
ConfigEntryType.TimeEntry)
}

def bytesConf(unit: ByteUnit): TypedConfigBuilder[Long] = {
checkPrependConfig
new TypedConfigBuilder(this, byteFromString(_, unit, key), byteToString(_, unit, key))
new TypedConfigBuilder(this, byteFromString(_, unit, key), byteToString(_, unit, key),
ConfigEntryType.BytesEntry)
}

def fallbackConf[T](fallback: ConfigEntry[T]): ConfigEntry[T] = {
Expand All @@ -361,7 +366,8 @@ private[spark] case class ConfigBuilder(key: String) {

def regexConf: TypedConfigBuilder[Regex] = {
checkPrependConfig
new TypedConfigBuilder(this, regexFromString(_, this.key), _.toString)
new TypedConfigBuilder(this, regexFromString(_, this.key), _.toString,
ConfigEntryType.RegexEntry)
}

private def checkPrependConfig = {
Expand Down
50 changes: 40 additions & 10 deletions common/utils/src/main/scala/org/apache/spark/internal/config/ConfigEntry.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,26 @@

package org.apache.spark.internal.config

/**
* Identifies the declared type of a [[ConfigEntry]] at construction time,
* avoiding runtime type probing or exception handling when the entry type
* needs to be inspected later (e.g. for optimized config access paths).
*/
private[spark] sealed trait ConfigEntryType extends Serializable

private[spark] object ConfigEntryType {
case object BooleanEntry extends ConfigEntryType
case object IntEntry extends ConfigEntryType
case object LongEntry extends ConfigEntryType
case object DoubleEntry extends ConfigEntryType
case object StringEntry extends ConfigEntryType
case object EnumEntry extends ConfigEntryType
case object TimeEntry extends ConfigEntryType
case object BytesEntry extends ConfigEntryType
case object RegexEntry extends ConfigEntryType
case object OtherEntry extends ConfigEntryType
}

// ====================================================================================
// The guideline for naming configurations
// ====================================================================================
Expand Down Expand Up @@ -80,7 +100,8 @@ private[spark] abstract class ConfigEntry[T] (
val stringConverter: T => String,
val doc: String,
val isPublic: Boolean,
val version: String) {
val version: String,
val configEntryType: ConfigEntryType) {

import ConfigEntry._

Expand Down Expand Up @@ -120,7 +141,8 @@ private class ConfigEntryWithDefault[T] (
stringConverter: T => String,
doc: String,
isPublic: Boolean,
version: String)
version: String,
configEntryType: ConfigEntryType)
extends ConfigEntry(
key,
prependedKey,
Expand All @@ -130,7 +152,8 @@ private class ConfigEntryWithDefault[T] (
stringConverter,
doc,
isPublic,
version
version,
configEntryType
) {

override def defaultValue: Option[T] = Some(_defaultValue)
Expand All @@ -152,7 +175,8 @@ private class ConfigEntryWithDefaultFunction[T] (
stringConverter: T => String,
doc: String,
isPublic: Boolean,
version: String)
version: String,
configEntryType: ConfigEntryType)
extends ConfigEntry(
key,
prependedKey,
Expand All @@ -162,7 +186,8 @@ private class ConfigEntryWithDefaultFunction[T] (
stringConverter,
doc,
isPublic,
version
version,
configEntryType
) {

override def defaultValue: Option[T] = Some(_defaultFunction())
Expand All @@ -184,7 +209,8 @@ private class ConfigEntryWithDefaultString[T] (
stringConverter: T => String,
doc: String,
isPublic: Boolean,
version: String)
version: String,
configEntryType: ConfigEntryType)
extends ConfigEntry(
key,
prependedKey,
Expand All @@ -194,7 +220,8 @@ private class ConfigEntryWithDefaultString[T] (
stringConverter,
doc,
isPublic,
version
version,
configEntryType
) {

override def defaultValue: Option[T] = Some(valueConverter(_defaultValue))
Expand All @@ -220,7 +247,8 @@ private[spark] class OptionalConfigEntry[T](
val rawStringConverter: T => String,
doc: String,
isPublic: Boolean,
version: String)
version: String,
configEntryType: ConfigEntryType)
extends ConfigEntry[Option[T]](
key,
prependedKey,
Expand All @@ -230,7 +258,8 @@ private[spark] class OptionalConfigEntry[T](
v => v.map(rawStringConverter).orNull,
doc,
isPublic,
version
version,
configEntryType
) {

override def defaultValueString: String = ConfigEntry.UNDEFINED
Expand Down Expand Up @@ -261,7 +290,8 @@ private[spark] class FallbackConfigEntry[T] (
fallback.stringConverter,
doc,
isPublic,
version
version,
fallback.configEntryType
) {

override def defaultValueString: String = s"<value of ${fallback.key}>"
Expand Down
Loading