[
https://issues.apache.org/jira/browse/DRILL-4699?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15557167#comment-15557167
]
ASF GitHub Bot commented on DRILL-4699:
---------------------------------------
Github user paul-rogers commented on a diff in the pull request:
https://github.com/apache/drill/pull/536#discussion_r82495327
--- Diff:
exec/java-exec/src/main/java/org/apache/drill/exec/ExecConstants.java ---
@@ -146,89 +158,121 @@
* |- bar - a.parquet
* |- baz - b.parquet
*/
- String FILESYSTEM_PARTITION_COLUMN_LABEL =
"drill.exec.storage.file.partition.column.label";
- OptionValidator FILESYSTEM_PARTITION_COLUMN_LABEL_VALIDATOR = new
StringValidator(FILESYSTEM_PARTITION_COLUMN_LABEL, "dir");
+ public static final String FILESYSTEM_PARTITION_COLUMN_LABEL =
"drill.exec.storage.file.partition.column.label";
+ public static final OptionValidator
FILESYSTEM_PARTITION_COLUMN_LABEL_VALIDATOR = new StringValidator(
+ FILESYSTEM_PARTITION_COLUMN_LABEL, "dir",
+ "The column label for directory levels in results of queries of
files in a directory. Accepts a string input.");
--- End diff --
Instead of saying that this takes a string, can we generate that part? We
look up the default value, infer the type and say:
The column label ... Type: string, Default: "dir"
Or, add type and default as additional columns. (Or maybe the default does
not matter, only the current value, so just list the type.)
> Add Description Column in sys.options
> -------------------------------------
>
> Key: DRILL-4699
> URL: https://issues.apache.org/jira/browse/DRILL-4699
> Project: Apache Drill
> Issue Type: Improvement
> Components: Server, Documentation
> Affects Versions: 1.6.0
> Reporter: John Omernik
> Assignee: Paul Rogers
>
> select * from sys.options provides a user with a strong understanding of what
> options are available to Drill. These options are not well documented. Some
> options are "experimental" other options have a function only in specific
> cases (writers vs readers for example). If we had a large text field for
> description, we could enforce documentation of the settings are option
> creation time, and the description of the setting could change as the
> versions change (i.e. when an option graduates to being supported from being
> experimental, it would be changed in the version the user is using. I.e. when
> they run select * from sys.options, they know the exact state of the option
> every time they query. It could also facilitate better self documentation via
> QA on pull requests "Did you update the sys.options.desc?" This makes it
> easier for users, and admins in the use of Drill in an enterprise.
> The first step is adding the field, and then going back and filling in the
> desc for each option. (Another JIRA after the option is available)
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
