gortiz commented on code in PR #13943: URL: https://github.com/apache/pinot/pull/13943#discussion_r1772688368
########## pinot-query-planner/src/main/java/org/apache/pinot/calcite/rel/rules/PinotImplicitTableHintRule.java: ########## @@ -0,0 +1,283 @@ +/** + * 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.List; +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.common.utils.DatabaseUtils; +import org.apache.pinot.core.routing.TablePartitionInfo; +import org.apache.pinot.spi.config.table.TableType; +import org.apache.pinot.spi.utils.builder.TableNameBuilder; +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 PartitionTableFinder _partitionTableFinder; + + private PinotImplicitTableHintRule(Config config) { + super(config); + _partitionTableFinder = config.getTablePartitionTableFinder(); + } + + public static PinotImplicitTableHintRule withPartitionTableFinder(PartitionTableFinder tablePartitionTableFinder) { + return new PinotImplicitTableHintRule(ImmutablePinotImplicitTableHintRule.Config.builder() + .operandSupplier(b0 -> b0.operand(LogicalTableScan.class).anyInputs()) + .tablePartitionTableFinder(tablePartitionTableFinder) + .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) + && kvOptions.containsKey(PinotHintOptions.TableHintOptions.PARTITION_PARALLELISM); + } + + @Override + public void onMatch(RelOptRuleCall call) { + LogicalTableScan tableScan = call.rel(0); + + TablePartitionInfo tablePartitionInfo = getTablePartitionInfo(tableScan); + if (tablePartitionInfo == null) { + LOGGER.debug("Table partition info not found for table: {}", tableScan); + return; + } + + @Nullable + RelHint explicitHint = getTableOptionHint(tableScan); + TableOptions tableOptions = calculateTableOptions(explicitHint, tablePartitionInfo, 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 tableOptionsHint = 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())) + .hintOption(PinotHintOptions.TableHintOptions.PARTITION_PARALLELISM, + String.valueOf(tableOptions.getPartitionParallelism())) + .build(); + + newHints.add(tableOptionsHint); + + 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, TablePartitionInfo tablePartitionInfo, LogicalTableScan tableScan) { + if (relHint == null) { + return ImmutablePinotImplicitTableHintRule.TableOptions.builder() + .partitionKey(tablePartitionInfo.getPartitionColumn()) + .partitionFunction(tablePartitionInfo.getPartitionFunctionName()) + .partitionSize(tablePartitionInfo.getNumPartitions()).partitionParallelism(1) + .build(); + } + + // there is a hint, check fill default data and obtain the partition parallelism if supplied + Map<String, String> kvOptions = relHint.kvOptions; + return ImmutablePinotImplicitTableHintRule.TableOptions.builder() + .partitionKey(getPartitionKey(tablePartitionInfo, tableScan, kvOptions)) + .partitionFunction(getPartitionFunction(tablePartitionInfo, tableScan, kvOptions)) + .partitionSize(getPartitionSize(tablePartitionInfo, tableScan, kvOptions)) + .partitionParallelism(getPartitionParallelism(tableScan, kvOptions)) + .build(); + } + + /** + * Get the partition key from the hint, if any, otherwise use the partition column from the table partition info. + */ + private static String getPartitionKey(TablePartitionInfo tablePartitionInfo, LogicalTableScan tableScan, + Map<String, String> kvOptions) { + String partitionKey = kvOptions.get(kvOptions.get(PinotHintOptions.TableHintOptions.PARTITION_KEY)); + if (partitionKey != null && !partitionKey.equals(tablePartitionInfo.getPartitionColumn())) { Review Comment: The function would return the same in both cases, but it will log unnecessarily. The idea here is to log if we are using the hint to ask for a partition that is not the one in the configuration. If we use the hint to specify the same partition we would use without the hint no log is necessary. This is specially important because people using colocated joins right now are actually providing the hint with this value, so we don't want to log in that case. Obviously the log is in debug and won't be actually loged in most environments, but given this is something that is logged for each query I wanted to be conservative. -- 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
