drill-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "ASF GitHub Bot (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (DRILL-4699) Add Description Column in sys.options
Date Tue, 28 Jun 2016 23:18:10 GMT

    [ https://issues.apache.org/jira/browse/DRILL-4699?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15353904#comment-15353904
] 

ASF GitHub Bot commented on DRILL-4699:
---------------------------------------

GitHub user sudheeshkatkam opened a pull request:

    https://github.com/apache/drill/pull/536

    DRILL-4699: Add description column to sys.options table

    + Add new constructor for each validator in TypeValidators with
      description field; deprecate old constructors
    + Add descriptions for some validators

You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/sudheeshkatkam/drill DRILL-4699

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/drill/pull/536.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #536
    
----
commit f8a78394423cca46aa3bfd63b2436c606df4b5b7
Author: Sudheesh Katkam <skatkam@maprtech.com>
Date:   2016-06-28T23:12:08Z

    DRILL-4699: Add description column to sys.options table
    
    + Add new constructor for each validator in TypeValidators with
      description field; deprecate old constructors
    + Add descriptions for some validators

----


> 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: Sudheesh Katkam
>
> 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)

Mime
View raw message