Uploaded image for project: 'Apache Drill'
  1. Apache Drill
  2. DRILL-4699

Add Description Column in sys.options

    XMLWordPrintableJSON

    Details

    • Type: Improvement
    • Status: Resolved
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: 1.6.0
    • Fix Version/s: 1.14.0
    • Component/s: Server, Documentation
    • Labels:
      None

      Description

      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)

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                kkhatua Kunal Khatua
                Reporter:
                mandoskippy John Omernik
              • Votes:
                0 Vote for this issue
                Watchers:
                6 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: