AbsaOSS / AbsaOSS/fixed-width

Detect unrecognized data source options

Open
#9 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Scala
Stars
4
Forks
0
PR merge metrics
No merged PRs in 30d

Description

## Background
Options are passed to Spark data sources as key-value pairs. It is very easy to make a typo in an option name. If the data source has a default behaviour for this option (e.g. the option is not mandatory), the passed option will be unrecognized and therefore ignored.

It would be very useful if the data source would detect unrecognized options.

## Feature
1. Detect unrecognized options and log them as warnings.
2. Add `.option("pedantic", true)`, which, when enabled, will fail the Spark Application if there is at least one unrecognized option passed to the source.

## Additional context
As an inspiration for possible implementation, Cobrix uses a wrapper that takes incoming options. All configuration is read from that wrapper instead of the original configuration. The wrapper records which options are queried at least once. At any given point it allows getting the list of options that haven't been used.
An advantage of such implementation is that if there are dependencies between options, e.g. a particular option is only used if some other option is enabled, it is tracked automatically.

https://github.com/AbsaOSS/cobrix/blob/master/spark-cobol/src/main/scala/za/co/absa/cobrix/spark/cobol/parameters/Parameters.scala

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.