[PARQUET-1826] Document hadoop configuration options

• Type: Improvement
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 1.12.0
• Component/s: parquet-mr
• Labels: pull-request-available
• Assignee: Walid Gara
• Reporter: Gabor Szadovszky
• Created: 25/Mar/20 08:34
• Updated: 27/Jan/21 14:33
• Resolved: 22/Apr/20 10:17

Description

The currently available hadoop configuration options is not documented properly. The only documentation we have is the javadoc comment and the implementation of ParquetOutputFormat.
We shall investigate all the possible options and their usage/default values and document them properly in a way that it is easily accessible by our users.

I would suggest creating a `README.md` file in the sub-module parquet-hadoop that would describe the purpose of the module and would have a section that lists the possible hadoop configuration options. (Later on we shall extend this document with other descriptions about the purpose and usage of our library in the hadoop ecosystem. These efforts shall be covered by other jiras.)

By adding the description to the source code it would be easy to extend it by the new features we implement so it will be up-to-date for every release.

Issue Links

• links to: GitHub Pull Request #781