Add Scan Hint Overrides

core/query/src/main/java/datawave/core/query/configuration/GenericQueryConfiguration.java

@@ -77,7 +77,10 @@ public class GenericQueryConfiguration implements Serializable {
 
     // either IMMEDIATE or EVENTUAL
     private Map<String,ScannerBase.ConsistencyLevel> tableConsistencyLevels = new HashMap<>();
+    // provides default scan hints
     private Map<String,Map<String,String>> tableHints = new HashMap<>();
+    // provides override scan hints
+    private Map<String,Map<String,String>> tableHintsOverride = new HashMap<>();
 
     /**
      * Empty default constructor
@@ -126,6 +129,7 @@ public void copyFrom(GenericQueryConfiguration other) {
         this.setReduceResults(other.isReduceResults());
         this.setTableConsistencyLevels(other.getTableConsistencyLevels());
         this.setTableHints(other.getTableHints());
+        this.setTableHintsOverride(other.getTableHintsOverride());
     }
 
     public Collection<QueryData> getQueries() {
@@ -316,6 +320,14 @@ public void setTableHints(Map<String,Map<String,String>> tableHints) {
         this.tableHints = tableHints;
     }
 
+    public Map<String,Map<String,String>> getTableHintsOverride() {
+        return tableHintsOverride;
+    }
+
+    public void setTableHintsOverride(Map<String,Map<String,String>> tableHintsOverride) {
+        this.tableHintsOverride = tableHintsOverride;
+    }
+
     /**
      * Checks for non-null, sane values for the configured values
      *

core/query/src/main/java/datawave/core/query/logic/BaseQueryLogic.java

@@ -459,4 +459,12 @@ public Map<String,Map<String,String>> getTableHints() {
     public void setTableHints(Map<String,Map<String,String>> hints) {
         getConfig().setTableHints(hints);
     }
+
+    public Map<String,Map<String,String>> getTableHintsOverride() {
+        return getConfig().getTableHintsOverride();
+    }
+
+    public void setTableHintsOverride(Map<String,Map<String,String>> hints) {
+        getConfig().setTableHintsOverride(hints);
+    }
 }

warehouse/query-core/src/main/java/datawave/query/jexl/lookups/BoundedRangeIndexLookup.java

@@ -4,6 +4,7 @@
 import java.text.MessageFormat;
 import java.util.Collections;
 import java.util.Iterator;
+import java.util.Map;
 import java.util.Map.Entry;
 import java.util.SortedMap;
 import java.util.concurrent.Callable;
@@ -172,6 +173,11 @@ public synchronized void submit() {
                     bs.addScanIterator(cfg);
                 }
 
+                if (config.getTableHintsOverride().containsKey(config.getIndexTableName())) {
+                    Map<String,String> hintOverride = config.getTableHintsOverride().get(config.getIndexTableName());
+                    bs.setExecutionHints(hintOverride);
+                }
+
                 timedScanFuture = execService.submit(createTimedCallable(bs.iterator()));
             } catch (TableNotFoundException e) {
                 NotFoundQueryException qe = new NotFoundQueryException(DatawaveErrorCode.TABLE_NOT_FOUND, e,

warehouse/query-core/src/main/java/datawave/query/jexl/lookups/ShardIndexQueryTableStaticMethods.java

@@ -464,6 +464,11 @@ public static ScannerSession configureTermMatchOnly(ShardQueryConfiguration conf
             options.addScanIterator(setting);
         }
 
+        if (config.getTableHintsOverride().containsKey(tableName)) {
+            Map<String,String> hintOverride = config.getTableHintsOverride().get(tableName);
+            options.setExecutionHints(hintOverride);
+        }
+
         bs.setOptions(options);
 
         return bs;
@@ -493,6 +498,11 @@ public static ScannerSession configureLimitedDiscovery(ShardQueryConfiguration c
             options.addScanIterator(setting);
         }
 
+        if (config.getTableHintsOverride().containsKey(tableName)) {
+            Map<String,String> hintOverride = config.getTableHintsOverride().get(tableName);
+            options.setExecutionHints(hintOverride);
+        }
+
         bs.setOptions(options);
 
         return bs;
@@ -506,6 +516,11 @@ public static final void configureGlobalIndexDateRangeFilter(ShardQueryConfigura
         }
         IteratorSetting cfg = configureGlobalIndexDateRangeFilter(config, dateRange);
         bs.addScanIterator(cfg);
+
+        if (config.getTableHintsOverride().containsKey(config.getIndexTableName())) {
+            Map<String,String> hintOverride = config.getTableHintsOverride().get(config.getIndexTableName());
+            bs.setExecutionHints(hintOverride);
+        }
     }
 
     public static final IteratorSetting configureGlobalIndexDateRangeFilter(ShardQueryConfiguration config, LongRange dateRange) {
@@ -575,6 +590,11 @@ public static final void configureGlobalIndexTermMatchingIterator(ShardQueryConf
 
         bs.addScanIterator(cfg);
 
+        if (config.getTableHintsOverride().containsKey(config.getIndexTableName())) {
+            Map<String,String> hintOverride = config.getTableHintsOverride().get(config.getIndexTableName());
+            bs.setExecutionHints(hintOverride);
+        }
+
         setExpansionFields(config, bs, reverseIndex, expansionFields);
     }
 

warehouse/query-core/src/test/java/datawave/query/config/ShardQueryConfigurationTest.java

@@ -591,6 +591,8 @@ public void setUp() throws Exception {
         updatedValues.put("tableConsistencyLevels", Collections.singletonMap(TableName.SHARD, ScannerBase.ConsistencyLevel.EVENTUAL));
         defaultValues.put("tableHints", Collections.emptyMap());
         updatedValues.put("tableHints", Collections.emptyMap());
+        defaultValues.put("tableHintsOverride", Collections.emptyMap());
+        updatedValues.put("tableHintsOverride", Collections.emptyMap());
 
         defaultValues.put("useQueryTreeScanHintRules", false);
         updatedValues.put("useQueryTreeScanHintRules", true);

warehouse/query-core/src/test/resources/datawave/query/QueryLogicFactory.xml

@@ -243,6 +243,15 @@
             </map>
         </property>
 
+        <property name="tableHintsOverride">
+            <map key-type="java.lang.String" value-type="java.util.Map">
+                <entry key="shardIndex">
+                    <!-- code hooks will use these overrides for shard index scans -->
+                    <map><entry key="scan_type" value="index-table-executor-lookup"/></map>
+                </entry>
+            </map>
+        </property>
+
         <property name="queryPlanner" ref="DefaultQueryPlanner" />
         <!--<property name="queryMacroFunction" ref="queryMacroFunction" />-->
         <property name="markingFunctions" ref="markingFunctions" />

web-services/query/src/test/java/datawave/webservice/query/configuration/TestBaseQueryLogic.java

@@ -83,6 +83,7 @@ public void testConstructor_Copy() throws Exception {
         expect(config.getQueriesIter()).andReturn(Collections.emptyIterator()).anyTimes();
         expect(config.getTableConsistencyLevels()).andReturn(Collections.emptyMap()).anyTimes();
         expect(config.getTableHints()).andReturn(Collections.emptyMap()).anyTimes();
+        expect(config.getTableHintsOverride()).andReturn(Collections.emptyMap()).anyTimes();
         expect(config.getConnPoolName()).andReturn("connPool1");
         expect(this.copy.getConfig()).andReturn(config).anyTimes();