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 Sat, 08 Oct 2016 04:34:24 GMT

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

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_r82495497
  
    --- Diff: exec/java-exec/src/main/java/org/apache/drill/exec/planner/physical/PlannerSettings.java
---
    @@ -46,40 +46,83 @@
       // max off heap memory for planning (16G)
       private static final long MAX_OFF_HEAP_ALLOCATION_IN_BYTES = 16l * 1024 * 1024 * 1024;
     
    -  public static final OptionValidator CONSTANT_FOLDING = new BooleanValidator("planner.enable_constant_folding",
true);
    +  public static final OptionValidator CONSTANT_FOLDING = new BooleanValidator("planner.enable_constant_folding",
true,
    +      "If one side of a filter condition is a constant expression, constant folding evaluates
the expression in the" +
    +          " planning phase and replaces the expression with the constant value. For example,
Drill can rewrite" +
    +          " this clause ' WHERE age + 5 < 42 as WHERE age < 37'.");
    +
       public static final OptionValidator EXCHANGE = new BooleanValidator("planner.disable_exchanges",
false);
    +
       public static final OptionValidator HASHAGG = new BooleanValidator("planner.enable_hashagg",
true);
    +
       public static final OptionValidator STREAMAGG = new BooleanValidator("planner.enable_streamagg",
true);
    -  public static final OptionValidator HASHJOIN = new BooleanValidator("planner.enable_hashjoin",
true);
    -  public static final OptionValidator MERGEJOIN = new BooleanValidator("planner.enable_mergejoin",
true);
    +
    +  public static final OptionValidator HASHJOIN = new BooleanValidator("planner.enable_hashjoin",
true,
    +      "Enable the memory hungry hash join. Drill assumes that a query with have adequate
memory to complete and" +
    --- End diff --
    
    with have --> will have


> 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)

Mime
View raw message