gortiz commented on code in PR #13943: URL: https://github.com/apache/pinot/pull/13943#discussion_r1801059669
########## pinot-query-planner/src/main/java/org/apache/pinot/calcite/rel/rules/PinotImplicitTableHintRule.java: ########## @@ -0,0 +1,225 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.apache.pinot.calcite.rel.rules; + +import java.util.ArrayList; +import java.util.Map; +import javax.annotation.Nullable; +import org.apache.calcite.plan.RelOptRuleCall; +import org.apache.calcite.plan.RelRule; +import org.apache.calcite.rel.RelNode; +import org.apache.calcite.rel.hint.RelHint; +import org.apache.calcite.rel.logical.LogicalTableScan; +import org.apache.pinot.calcite.rel.hint.PinotHintOptions; +import org.apache.pinot.query.planner.logical.RelToPlanNodeConverter; +import org.apache.pinot.query.routing.WorkerManager; +import org.immutables.value.Value; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +@Value.Enclosing +public class PinotImplicitTableHintRule extends RelRule<RelRule.Config> { + + private static final Logger LOGGER = LoggerFactory.getLogger(PinotImplicitTableHintRule.class); + private final WorkerManager _workerManager; + + private PinotImplicitTableHintRule(Config config) { + super(config); + _workerManager = config.getWorkerManager(); + } + + public static PinotImplicitTableHintRule withWorkerManager(WorkerManager workerManager) { + return new PinotImplicitTableHintRule(ImmutablePinotImplicitTableHintRule.Config.builder() + .operandSupplier(b0 -> b0.operand(LogicalTableScan.class).anyInputs()) + .workerManager(workerManager) + .build() + ); + } + + @Override + public boolean matches(RelOptRuleCall call) { + LogicalTableScan tableScan = call.rel(0); + + RelHint explicitHint = getTableOptionHint(tableScan); + + if (explicitHint == null) { + return true; + } + // we don't want to apply this rule if the explicit hint is complete + Map<String, String> kvOptions = explicitHint.kvOptions; + return kvOptions.containsKey(PinotHintOptions.TableHintOptions.PARTITION_KEY) + && kvOptions.containsKey(PinotHintOptions.TableHintOptions.PARTITION_FUNCTION) + && kvOptions.containsKey(PinotHintOptions.TableHintOptions.PARTITION_SIZE); + } + + @Override + public void onMatch(RelOptRuleCall call) { + LogicalTableScan tableScan = call.rel(0); + + String tableName = RelToPlanNodeConverter.getTableNameFromTableScan(tableScan); + @Nullable + TableOptions implicitTableOptions = _workerManager.inferTableOptions(tableName); + if (implicitTableOptions == null) { + return; + } + + @Nullable + RelHint explicitHint = getTableOptionHint(tableScan); + TableOptions tableOptions = calculateTableOptions(explicitHint, implicitTableOptions, tableScan); + RelNode newRel = withNewTableOptions(tableScan, tableOptions); + call.transformTo(newRel); + } + + /** + * Get the table option hint from the table scan, if any. + */ + @Nullable + private static RelHint getTableOptionHint(LogicalTableScan tableScan) { + return tableScan.getHints().stream() + .filter(relHint -> relHint.hintName.equals(PinotHintOptions.TABLE_HINT_OPTIONS)) + .findAny() + .orElse(null); + } + + /** + * Returns a new node which is a copy of the given table scan with the new table options hint. + */ + private static RelNode withNewTableOptions(LogicalTableScan tableScan, TableOptions tableOptions) { + ArrayList<RelHint> newHints = new ArrayList<>(tableScan.getHints()); + + newHints.removeIf(relHint -> relHint.hintName.equals(PinotHintOptions.TABLE_HINT_OPTIONS)); + + RelHint.Builder builder = RelHint.builder(PinotHintOptions.TABLE_HINT_OPTIONS) + .hintOption(PinotHintOptions.TableHintOptions.PARTITION_KEY, tableOptions.getPartitionKey()) + .hintOption(PinotHintOptions.TableHintOptions.PARTITION_FUNCTION, tableOptions.getPartitionFunction()) + .hintOption(PinotHintOptions.TableHintOptions.PARTITION_SIZE, String.valueOf(tableOptions.getPartitionSize())); + + if (tableOptions.getPartitionParallelism() != null) { + builder.hintOption(PinotHintOptions.TableHintOptions.PARTITION_PARALLELISM, + String.valueOf(tableOptions.getPartitionParallelism())); + } + + newHints.add(builder.build()); + + return tableScan.withHints(newHints); + } + + /** + * Creates a new table options hint based on the given table partition info and the explicit hint, if any. + * + * Any explicit hint will override the implicit hint obtained from the table partition info. + */ + private static TableOptions calculateTableOptions( + @Nullable RelHint relHint, TableOptions implicitTableOptions, LogicalTableScan tableScan) { + if (relHint == null) { + return implicitTableOptions; + } + + // there is a hint, check fill default data and obtain the partition parallelism if supplied + Map<String, String> kvOptions = relHint.kvOptions; + + ImmutableTableOptions newTableOptions = ImmutableTableOptions.copyOf(implicitTableOptions); Review Comment: This code is here in case there is an explicit hint, in which case the explicit value provided by the writer wins. That is what is called override here. The base `ImmutableTableOptions` is the one calculated from the table and does not include partition information. Then for each dimension on TableOptions (key, function, etc) the implicit value is override by the explicit value provided, if any. The code that enforces a specific value is in `WorkerManager`. We could move it here, but I think that can be done in another PR. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: commits-unsubscr...@pinot.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@pinot.apache.org For additional commands, e-mail: commits-h...@pinot.apache.org
