xi-db opened a new pull request, #48264:
URL: https://github.com/apache/spark/pull/48264
### What changes were proposed in this pull request?
The existing documentation of `RuntimeConfig.get()` is misleading:
* `get(key: String)` method will not throw any exception if the key is not
set as long as the config entry has a default value, instead, they will just
return the `defaultValue` of the `ConfigEntry`. An `NoSuchElementException`
will only be thrown if there is no default value for the config entry.
* `get(key: String, default: String)` method will ignore the `defaultValue`
of its `ConfigEntry`, and return the given param `default` if unset.
* `getOption(key: String)` method will return the `defaultValue` of its
`ConfigEntry` if the config is not set.
An example:
This line makes sure the config is not set.
```
scala> spark.conf.unset("spark.sql.session.timeZone")
```
The following code returns `Etc/UTC`, which doesn't throw any exception.
```
scala> spark.conf.get("spark.sql.session.timeZone")
res2: String = "Etc/UTC"
```
The following code returns `Europe/Berlin`, ignoring the default value.
However, the documentation only says it returns the value, without mentioning
ignoring the default value of the entry when the config is not explicitly set.
```
scala> spark.conf.get("spark.sql.session.timeZone", "Europe/Berlin")
res3: String = "Europe/Berlin"
```
In this PR, the documentation is fixed and a new test case is added.
### Why are the changes needed?
The incorrect documentation is likely to mislead users to weird behaviours
if they rely on the documentation.
### Does this PR introduce _any_ user-facing change?
No.
### How was this patch tested?
New test case in `RuntimeConfigSuite`.
### Was this patch authored or co-authored using generative AI tooling?
No.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
