Jackie-Jiang commented on code in PR #13943:
URL: https://github.com/apache/pinot/pull/13943#discussion_r1796556857
##########
pinot-query-planner/src/main/java/org/apache/pinot/query/routing/WorkerManager.java:
##########
@@ -484,79 +507,119 @@ private PartitionTableInfo getPartitionTableInfo(String
tableName, String partit
fullyReplicatedServers.retainAll(realtimePartitionInfo._fullyReplicatedServers);
Preconditions.checkState(!fullyReplicatedServers.isEmpty(),
"Failed to find fully replicated server for partition: %s in
hybrid table: %s", i, tableName);
- partitionInfoMap[i] = new PartitionInfo(fullyReplicatedServers,
offlinePartitionInfo._segments,
- realtimePartitionInfo._segments);
+ partitionInfoMap[i] = new PartitionInfo(
+ fullyReplicatedServers, offlinePartitionInfo._segments,
realtimePartitionInfo._segments);
}
- return new PartitionTableInfo(partitionInfoMap, timeBoundaryInfo);
+ return new PartitionTableInfo(partitionInfoMap, timeBoundaryInfo,
offlineTpi.getPartitionColumn(),
+ numPartitions, offlineTpi.getPartitionFunctionName());
} else if (offlineRoutingExists) {
- return getOfflinePartitionTableInfo(offlineTableName, partitionKey,
numPartitions, partitionFunction);
+ return getOfflinePartitionTableInfo(offlineTableName);
} else {
- return getRealtimePartitionTableInfo(realtimeTableName, partitionKey,
numPartitions, partitionFunction);
+ return getRealtimePartitionTableInfo(realtimeTableName);
}
} else {
if (tableType == TableType.OFFLINE) {
- return getOfflinePartitionTableInfo(tableName, partitionKey,
numPartitions, partitionFunction);
+ return getOfflinePartitionTableInfo(tableName);
} else {
- return getRealtimePartitionTableInfo(tableName, partitionKey,
numPartitions, partitionFunction);
+ return getRealtimePartitionTableInfo(tableName);
}
}
}
- private TablePartitionInfo getTablePartitionInfo(String tableNameWithType,
String partitionKey, int numPartitions,
- String partitionFunction) {
- TablePartitionInfo tablePartitionInfo =
_routingManager.getTablePartitionInfo(tableNameWithType);
- Preconditions.checkState(tablePartitionInfo != null, "Failed to find table
partition info for table: %s",
- tableNameWithType);
-
Preconditions.checkState(tablePartitionInfo.getPartitionColumn().equals(partitionKey),
+ private static void verifyCompatibility(TablePartitionInfo offlineTpi,
TablePartitionInfo realtimeTpi) {
+
Preconditions.checkState(offlineTpi.getTableNameWithType().equals(realtimeTpi.getTableNameWithType()),
Review Comment:
They shouldn't match because they have different suffix
##########
pinot-query-planner/src/main/java/org/apache/pinot/calcite/rel/rules/PinotImplicitTableHintRule.java:
##########
@@ -0,0 +1,316 @@
+/**
+ * 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.core.routing.TablePartitionInfo;
+import org.apache.pinot.query.planner.logical.RelToPlanNodeConverter;
+import org.apache.pinot.query.routing.WorkerManager;
+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 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);
+
+ TablePartitionInfo tablePartitionInfo = getTablePartitionInfo(tableScan);
+ if (tablePartitionInfo == null) {
+ 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.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, TablePartitionInfo tablePartitionInfo,
LogicalTableScan tableScan) {
+ if (relHint == null) {
+ return ImmutablePinotImplicitTableHintRule.TableOptions.builder()
Review Comment:
I checked out the code but cannot find this class in IDE. Is this auto
generated by the annotation framework?
##########
pinot-spi/src/main/java/org/apache/pinot/spi/utils/CommonConstants.java:
##########
@@ -343,6 +343,8 @@ public static class Broker {
public static final String CONFIG_OF_ENABLE_PARTITION_METADATA_MANAGER =
"pinot.broker.enable.partition.metadata.manager";
public static final boolean DEFAULT_ENABLE_PARTITION_METADATA_MANAGER =
false;
+ public static final String IMPLICIT_COLOCATE_JOIN =
"pinot.broker.multistage.implicit.colocate";
Review Comment:
Something like `AUTO_HINT_PARTITION_INFO` or `AUTO_APPLY_PARTITION_HINT`?
##########
pinot-query-planner/src/main/java/org/apache/pinot/calcite/rel/rules/PinotImplicitTableHintRule.java:
##########
@@ -0,0 +1,316 @@
+/**
+ * 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.core.routing.TablePartitionInfo;
+import org.apache.pinot.query.planner.logical.RelToPlanNodeConverter;
+import org.apache.pinot.query.routing.WorkerManager;
+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 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);
+
+ TablePartitionInfo tablePartitionInfo = getTablePartitionInfo(tableScan);
+ if (tablePartitionInfo == null) {
+ 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.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, TablePartitionInfo tablePartitionInfo,
LogicalTableScan tableScan) {
+ if (relHint == null) {
+ return ImmutablePinotImplicitTableHintRule.TableOptions.builder()
+ .partitionKey(tablePartitionInfo.getPartitionColumn())
+ .partitionFunction(tablePartitionInfo.getPartitionFunctionName())
+ .partitionSize(tablePartitionInfo.getNumPartitions())
+ // We don't want to set partition parallelism, given it has side
effects.
+ // See PinotHintOptions.TableHintOptions.PARTITION_PARALLELISM for
more details.
+ //.partitionParallelism(1)
+ .build();
+ }
+
+ // there is a hint, check fill default data and obtain the partition
parallelism if supplied
+ Map<String, String> kvOptions = relHint.kvOptions;
+ ImmutablePinotImplicitTableHintRule.TableOptions.Builder builder =
+ ImmutablePinotImplicitTableHintRule.TableOptions.builder()
+ .partitionKey(getPartitionKey(tablePartitionInfo, tableScan,
kvOptions))
+ .partitionFunction(getPartitionFunction(tablePartitionInfo,
tableScan, kvOptions))
+ .partitionSize(getPartitionSize(tablePartitionInfo, tableScan,
kvOptions));
+
+ Integer partitionParallelism = getPartitionParallelism(tableScan,
kvOptions);
+ if (partitionParallelism != null) { // only set parallelism if it is
explicitly set
+ builder.partitionParallelism(partitionParallelism);
+ }
+ return builder.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())) {
+ LOGGER.debug("Override implicit table hint for {} with explicit
partition key: {}", tableScan, partitionKey);
+ return partitionKey;
+ } else {
+ return tablePartitionInfo.getPartitionColumn();
+ }
+ }
+
+ /**
+ * Get the partition function from the hint, if any, otherwise use the
partition function from the table partition
+ * info.
+ */
+ private static String getPartitionFunction(TablePartitionInfo
tablePartitionInfo, LogicalTableScan tableScan,
+ Map<String, String> kvOptions) {
+ String partitionFunction =
kvOptions.get(kvOptions.get(PinotHintOptions.TableHintOptions.PARTITION_FUNCTION));
+ if (partitionFunction != null &&
!partitionFunction.equals(tablePartitionInfo.getPartitionFunctionName())) {
+ LOGGER.debug("Override implicit table hint for {} with explicit
partition function: {}",
+ tableScan, partitionFunction);
+ return partitionFunction;
+ } else {
+ return tablePartitionInfo.getPartitionFunctionName();
+ }
+ }
+
+ /**
+ * Get the partition parallelism from the hint, if any, otherwise returns
null.
+ */
+ @Nullable
+ private static Integer getPartitionParallelism(LogicalTableScan tableScan,
Map<String, String> kvOptions) {
+ String partitionParallelismStr =
kvOptions.get(PinotHintOptions.TableHintOptions.PARTITION_PARALLELISM);
+ if (partitionParallelismStr != null) {
+ try {
+ int partitionParallelism = Integer.parseInt(partitionParallelismStr);
+ LOGGER.debug("Override implicit table hint for {} with explicit
partition parallelism: {}", tableScan,
+ partitionParallelism);
+ return partitionParallelism;
+ } catch (NumberFormatException e) {
+ throw new IllegalArgumentException(
+ "Invalid partition parallelism: " + partitionParallelismStr + "
for table: " + tableScan);
+ }
+ }
+ return null;
+ }
+
+ /**
+ * Get the partition size from the hint, if any, otherwise use the partition
size from the table partition info.
+ */
+ private static int getPartitionSize(TablePartitionInfo tablePartitionInfo,
LogicalTableScan tableScan,
+ Map<String, String> kvOptions) {
+ int partitionSize = tablePartitionInfo.getNumPartitions();
+ String partitionSizeStr =
kvOptions.get(PinotHintOptions.TableHintOptions.PARTITION_SIZE);
+ if (partitionSizeStr != null) {
+ try {
+ int explicitPartitionSize = Integer.parseInt(partitionSizeStr);
+ if (explicitPartitionSize != partitionSize) {
+ LOGGER.debug("Override implicit table hint for {} with explicit
partition size: {}", tableScan,
+ explicitPartitionSize);
+ partitionSize = explicitPartitionSize;
+ }
+ } catch (NumberFormatException e) {
+ throw new IllegalArgumentException("Invalid partition size: " +
partitionSizeStr + " for table: " + tableScan);
+ }
+ }
+ return partitionSize;
+ }
+
+ /**
+ * Get the table partition info for the given table scan, transforming
Calcite's table name to Pinot's table name
+ * and adding the table type if needed.
+ */
+ @Nullable
+ private TablePartitionInfo getTablePartitionInfo(LogicalTableScan tableScan)
{
+ String tableName =
RelToPlanNodeConverter.getTableNameFromTableScan(tableScan);
+
+ String offlineName =
TableNameBuilder.forType(TableType.OFFLINE).tableNameWithType(tableName);
+ TablePartitionInfo offlineTpi =
_workerManager.getTablePartitionInfo(offlineName);
Review Comment:
One possible scenario is that both tables exist, but only one table has
partition info. In that case we should return `null` instead
##########
pom.xml:
##########
@@ -1444,8 +1444,10 @@
<!-- Required by Calcite -->
<dependency>
<groupId>org.immutables</groupId>
- <artifactId>value-annotations</artifactId>
+ <artifactId>bom</artifactId>
Review Comment:
(minor) Do we still need this `BOM`?
##########
pinot-query-planner/src/main/java/org/apache/pinot/calcite/rel/rules/PinotImplicitTableHintRule.java:
##########
@@ -0,0 +1,316 @@
+/**
+ * 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.core.routing.TablePartitionInfo;
+import org.apache.pinot.query.planner.logical.RelToPlanNodeConverter;
+import org.apache.pinot.query.routing.WorkerManager;
+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 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);
+
+ TablePartitionInfo tablePartitionInfo = getTablePartitionInfo(tableScan);
+ if (tablePartitionInfo == null) {
+ 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.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, TablePartitionInfo tablePartitionInfo,
LogicalTableScan tableScan) {
+ if (relHint == null) {
+ return ImmutablePinotImplicitTableHintRule.TableOptions.builder()
+ .partitionKey(tablePartitionInfo.getPartitionColumn())
+ .partitionFunction(tablePartitionInfo.getPartitionFunctionName())
+ .partitionSize(tablePartitionInfo.getNumPartitions())
+ // We don't want to set partition parallelism, given it has side
effects.
+ // See PinotHintOptions.TableHintOptions.PARTITION_PARALLELISM for
more details.
+ //.partitionParallelism(1)
+ .build();
+ }
+
+ // there is a hint, check fill default data and obtain the partition
parallelism if supplied
+ Map<String, String> kvOptions = relHint.kvOptions;
+ ImmutablePinotImplicitTableHintRule.TableOptions.Builder builder =
+ ImmutablePinotImplicitTableHintRule.TableOptions.builder()
+ .partitionKey(getPartitionKey(tablePartitionInfo, tableScan,
kvOptions))
+ .partitionFunction(getPartitionFunction(tablePartitionInfo,
tableScan, kvOptions))
+ .partitionSize(getPartitionSize(tablePartitionInfo, tableScan,
kvOptions));
+
+ Integer partitionParallelism = getPartitionParallelism(tableScan,
kvOptions);
+ if (partitionParallelism != null) { // only set parallelism if it is
explicitly set
+ builder.partitionParallelism(partitionParallelism);
+ }
+ return builder.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())) {
+ LOGGER.debug("Override implicit table hint for {} with explicit
partition key: {}", tableScan, partitionKey);
+ return partitionKey;
+ } else {
+ return tablePartitionInfo.getPartitionColumn();
+ }
+ }
+
+ /**
+ * Get the partition function from the hint, if any, otherwise use the
partition function from the table partition
+ * info.
+ */
+ private static String getPartitionFunction(TablePartitionInfo
tablePartitionInfo, LogicalTableScan tableScan,
+ Map<String, String> kvOptions) {
+ String partitionFunction =
kvOptions.get(kvOptions.get(PinotHintOptions.TableHintOptions.PARTITION_FUNCTION));
+ if (partitionFunction != null &&
!partitionFunction.equals(tablePartitionInfo.getPartitionFunctionName())) {
+ LOGGER.debug("Override implicit table hint for {} with explicit
partition function: {}",
+ tableScan, partitionFunction);
+ return partitionFunction;
+ } else {
+ return tablePartitionInfo.getPartitionFunctionName();
+ }
+ }
+
+ /**
+ * Get the partition parallelism from the hint, if any, otherwise returns
null.
+ */
+ @Nullable
+ private static Integer getPartitionParallelism(LogicalTableScan tableScan,
Map<String, String> kvOptions) {
+ String partitionParallelismStr =
kvOptions.get(PinotHintOptions.TableHintOptions.PARTITION_PARALLELISM);
+ if (partitionParallelismStr != null) {
+ try {
+ int partitionParallelism = Integer.parseInt(partitionParallelismStr);
+ LOGGER.debug("Override implicit table hint for {} with explicit
partition parallelism: {}", tableScan,
+ partitionParallelism);
+ return partitionParallelism;
+ } catch (NumberFormatException e) {
+ throw new IllegalArgumentException(
+ "Invalid partition parallelism: " + partitionParallelismStr + "
for table: " + tableScan);
+ }
+ }
+ return null;
+ }
+
+ /**
+ * Get the partition size from the hint, if any, otherwise use the partition
size from the table partition info.
+ */
+ private static int getPartitionSize(TablePartitionInfo tablePartitionInfo,
LogicalTableScan tableScan,
+ Map<String, String> kvOptions) {
+ int partitionSize = tablePartitionInfo.getNumPartitions();
+ String partitionSizeStr =
kvOptions.get(PinotHintOptions.TableHintOptions.PARTITION_SIZE);
+ if (partitionSizeStr != null) {
+ try {
+ int explicitPartitionSize = Integer.parseInt(partitionSizeStr);
+ if (explicitPartitionSize != partitionSize) {
+ LOGGER.debug("Override implicit table hint for {} with explicit
partition size: {}", tableScan,
+ explicitPartitionSize);
+ partitionSize = explicitPartitionSize;
+ }
+ } catch (NumberFormatException e) {
+ throw new IllegalArgumentException("Invalid partition size: " +
partitionSizeStr + " for table: " + tableScan);
+ }
+ }
+ return partitionSize;
+ }
+
+ /**
+ * Get the table partition info for the given table scan, transforming
Calcite's table name to Pinot's table name
+ * and adding the table type if needed.
+ */
+ @Nullable
+ private TablePartitionInfo getTablePartitionInfo(LogicalTableScan tableScan)
{
+ String tableName =
RelToPlanNodeConverter.getTableNameFromTableScan(tableScan);
Review Comment:
The name might already have type suffix. We should try to extract the type
first
##########
pinot-query-planner/src/main/java/org/apache/pinot/calcite/rel/rules/PinotImplicitTableHintRule.java:
##########
@@ -0,0 +1,316 @@
+/**
+ * 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.core.routing.TablePartitionInfo;
+import org.apache.pinot.query.planner.logical.RelToPlanNodeConverter;
+import org.apache.pinot.query.routing.WorkerManager;
+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 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);
+
+ TablePartitionInfo tablePartitionInfo = getTablePartitionInfo(tableScan);
+ if (tablePartitionInfo == null) {
+ 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.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, TablePartitionInfo tablePartitionInfo,
LogicalTableScan tableScan) {
+ if (relHint == null) {
+ return ImmutablePinotImplicitTableHintRule.TableOptions.builder()
+ .partitionKey(tablePartitionInfo.getPartitionColumn())
+ .partitionFunction(tablePartitionInfo.getPartitionFunctionName())
+ .partitionSize(tablePartitionInfo.getNumPartitions())
+ // We don't want to set partition parallelism, given it has side
effects.
+ // See PinotHintOptions.TableHintOptions.PARTITION_PARALLELISM for
more details.
+ //.partitionParallelism(1)
+ .build();
+ }
+
+ // there is a hint, check fill default data and obtain the partition
parallelism if supplied
+ Map<String, String> kvOptions = relHint.kvOptions;
+ ImmutablePinotImplicitTableHintRule.TableOptions.Builder builder =
+ ImmutablePinotImplicitTableHintRule.TableOptions.builder()
+ .partitionKey(getPartitionKey(tablePartitionInfo, tableScan,
kvOptions))
+ .partitionFunction(getPartitionFunction(tablePartitionInfo,
tableScan, kvOptions))
+ .partitionSize(getPartitionSize(tablePartitionInfo, tableScan,
kvOptions));
+
+ Integer partitionParallelism = getPartitionParallelism(tableScan,
kvOptions);
+ if (partitionParallelism != null) { // only set parallelism if it is
explicitly set
+ builder.partitionParallelism(partitionParallelism);
+ }
+ return builder.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())) {
+ LOGGER.debug("Override implicit table hint for {} with explicit
partition key: {}", tableScan, partitionKey);
+ return partitionKey;
+ } else {
+ return tablePartitionInfo.getPartitionColumn();
+ }
+ }
+
+ /**
+ * Get the partition function from the hint, if any, otherwise use the
partition function from the table partition
+ * info.
+ */
+ private static String getPartitionFunction(TablePartitionInfo
tablePartitionInfo, LogicalTableScan tableScan,
+ Map<String, String> kvOptions) {
+ String partitionFunction =
kvOptions.get(kvOptions.get(PinotHintOptions.TableHintOptions.PARTITION_FUNCTION));
+ if (partitionFunction != null &&
!partitionFunction.equals(tablePartitionInfo.getPartitionFunctionName())) {
+ LOGGER.debug("Override implicit table hint for {} with explicit
partition function: {}",
+ tableScan, partitionFunction);
+ return partitionFunction;
+ } else {
+ return tablePartitionInfo.getPartitionFunctionName();
+ }
+ }
+
+ /**
+ * Get the partition parallelism from the hint, if any, otherwise returns
null.
+ */
+ @Nullable
+ private static Integer getPartitionParallelism(LogicalTableScan tableScan,
Map<String, String> kvOptions) {
+ String partitionParallelismStr =
kvOptions.get(PinotHintOptions.TableHintOptions.PARTITION_PARALLELISM);
+ if (partitionParallelismStr != null) {
+ try {
+ int partitionParallelism = Integer.parseInt(partitionParallelismStr);
+ LOGGER.debug("Override implicit table hint for {} with explicit
partition parallelism: {}", tableScan,
+ partitionParallelism);
+ return partitionParallelism;
+ } catch (NumberFormatException e) {
+ throw new IllegalArgumentException(
+ "Invalid partition parallelism: " + partitionParallelismStr + "
for table: " + tableScan);
+ }
+ }
+ return null;
+ }
+
+ /**
+ * Get the partition size from the hint, if any, otherwise use the partition
size from the table partition info.
+ */
+ private static int getPartitionSize(TablePartitionInfo tablePartitionInfo,
LogicalTableScan tableScan,
+ Map<String, String> kvOptions) {
+ int partitionSize = tablePartitionInfo.getNumPartitions();
+ String partitionSizeStr =
kvOptions.get(PinotHintOptions.TableHintOptions.PARTITION_SIZE);
+ if (partitionSizeStr != null) {
+ try {
+ int explicitPartitionSize = Integer.parseInt(partitionSizeStr);
+ if (explicitPartitionSize != partitionSize) {
+ LOGGER.debug("Override implicit table hint for {} with explicit
partition size: {}", tableScan,
+ explicitPartitionSize);
+ partitionSize = explicitPartitionSize;
+ }
+ } catch (NumberFormatException e) {
+ throw new IllegalArgumentException("Invalid partition size: " +
partitionSizeStr + " for table: " + tableScan);
+ }
+ }
+ return partitionSize;
+ }
+
+ /**
+ * Get the table partition info for the given table scan, transforming
Calcite's table name to Pinot's table name
+ * and adding the table type if needed.
+ */
+ @Nullable
+ private TablePartitionInfo getTablePartitionInfo(LogicalTableScan tableScan)
{
+ String tableName =
RelToPlanNodeConverter.getTableNameFromTableScan(tableScan);
+
+ String offlineName =
TableNameBuilder.forType(TableType.OFFLINE).tableNameWithType(tableName);
+ TablePartitionInfo offlineTpi =
_workerManager.getTablePartitionInfo(offlineName);
+ String realtimeName =
TableNameBuilder.forType(TableType.REALTIME).tableNameWithType(tableName);
+ TablePartitionInfo realtimeTpi =
_workerManager.getTablePartitionInfo(realtimeName);
+
+ if (offlineTpi == null && realtimeTpi == null) {
+ LOGGER.debug("Table partition info not found for table: {}", tableName);
+ return null;
+ }
+ if (offlineTpi == null) {
+ return realtimeTpi;
+ }
+ if (realtimeTpi == null) {
+ return offlineTpi;
+ }
+ if (!_workerManager.isFullyReplicated(tableName)) {
+ LOGGER.debug("Table {} is not fully replicated", tableName);
+ return null;
+ }
+ // both tpis are equal, so we can return either
+ return offlineTpi;
+ }
+
+ @Value.Immutable
+ public interface Config extends RelRule.Config {
+ @Nullable
+ WorkerManager getWorkerManager();
+
+ @Override
+ default PinotImplicitTableHintRule toRule() {
+ return new PinotImplicitTableHintRule(this);
+ }
+ }
+
+ /**
+ * An interface to find the table partition info for a given table name.
+ */
+ public interface PartitionTableFinder {
Review Comment:
Is this used?
--
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
