Jackie-Jiang commented on code in PR #15388: URL: https://github.com/apache/pinot/pull/15388#discussion_r2056924417
########## pinot-query-planner/src/main/java/org/apache/pinot/query/routing/table/TableRouteProvider.java: ########## @@ -0,0 +1,49 @@ +/** + * 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.query.routing.table; + +import org.apache.pinot.common.config.provider.TableCache; +import org.apache.pinot.common.request.BrokerRequest; +import org.apache.pinot.core.routing.RoutingManager; +import org.apache.pinot.core.transport.ImplicitHybridTableRouteInfo; +import org.apache.pinot.core.transport.TableRouteInfo; + + +/** + * The TableRoute interface provides the metadata required to route query execution to servers. The important sources + * of the metadata are table config, broker routing information and the broker request. + */ +public interface TableRouteProvider { + ImplicitHybridTableRouteInfo getTableRouteInfo(String tableName, TableCache tableCache, Review Comment: Should this return `TableRouteInfo`? ########## pinot-core/src/main/java/org/apache/pinot/core/transport/TableRouteInfo.java: ########## @@ -0,0 +1,198 @@ +/** + * 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.core.transport; + +import java.util.List; +import java.util.Map; +import java.util.Set; +import javax.annotation.Nullable; +import org.apache.pinot.common.request.BrokerRequest; +import org.apache.pinot.common.request.InstanceRequest; +import org.apache.pinot.core.routing.ServerRouteInfo; +import org.apache.pinot.core.routing.TimeBoundaryInfo; +import org.apache.pinot.spi.config.table.TableConfig; + + +/** + * Routing information for a table required to route plan fragments to servers. + * RequestMap is used to submit plan fragments to servers. + * Offline and realtime routing tables are used to keep track of which servers are executing the query. + * getUnavailableSegments() returns the segments that are not available when calculating the routing table. + * numPrunedSegmentsTotal() returns the number of segments that were pruned when calculating the routing table. + */ +public interface TableRouteInfo { Review Comment: Do we need an interface for the route info? I feel it should be a concrete class with just information needed for routing purpose ########## pinot-query-planner/src/main/java/org/apache/pinot/query/routing/table/TableRouteProvider.java: ########## @@ -0,0 +1,49 @@ +/** + * 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.query.routing.table; + +import org.apache.pinot.common.config.provider.TableCache; +import org.apache.pinot.common.request.BrokerRequest; +import org.apache.pinot.core.routing.RoutingManager; +import org.apache.pinot.core.transport.ImplicitHybridTableRouteInfo; +import org.apache.pinot.core.transport.TableRouteInfo; + + +/** + * The TableRoute interface provides the metadata required to route query execution to servers. The important sources + * of the metadata are table config, broker routing information and the broker request. + */ +public interface TableRouteProvider { + ImplicitHybridTableRouteInfo getTableRouteInfo(String tableName, TableCache tableCache, Review Comment: What is the difference between `getTableRouteInfo()` vs `calculateRoutes()`? Seems like right now the routing computation is split into 3 pieces: 1. `getTableRouteInfo()` 2. Some logic in `BaseSingleStageBrokerRequestHandler` 3. `calculateRoutes()` Ideally all of them should be handled in this class. Any specific reason why we split it into 3 parts? ########## pinot-core/src/main/java/org/apache/pinot/core/transport/TableRouteInfo.java: ########## @@ -0,0 +1,198 @@ +/** + * 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.core.transport; + +import java.util.List; +import java.util.Map; +import java.util.Set; +import javax.annotation.Nullable; +import org.apache.pinot.common.request.BrokerRequest; +import org.apache.pinot.common.request.InstanceRequest; +import org.apache.pinot.core.routing.ServerRouteInfo; +import org.apache.pinot.core.routing.TimeBoundaryInfo; +import org.apache.pinot.spi.config.table.TableConfig; + + +/** + * Routing information for a table required to route plan fragments to servers. + * RequestMap is used to submit plan fragments to servers. + * Offline and realtime routing tables are used to keep track of which servers are executing the query. + * getUnavailableSegments() returns the segments that are not available when calculating the routing table. + * numPrunedSegmentsTotal() returns the number of segments that were pruned when calculating the routing table. + */ +public interface TableRouteInfo { + + @Nullable + String getOfflineTableName(); + + @Nullable + String getRealtimeTableName(); Review Comment: These 2 are not general abstraction, and doesn't apply to logical table ########## pinot-core/src/main/java/org/apache/pinot/core/transport/TableRouteInfo.java: ########## @@ -0,0 +1,198 @@ +/** + * 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.core.transport; + +import java.util.List; +import java.util.Map; +import java.util.Set; +import javax.annotation.Nullable; +import org.apache.pinot.common.request.BrokerRequest; +import org.apache.pinot.common.request.InstanceRequest; +import org.apache.pinot.core.routing.ServerRouteInfo; +import org.apache.pinot.core.routing.TimeBoundaryInfo; +import org.apache.pinot.spi.config.table.TableConfig; + + +/** + * Routing information for a table required to route plan fragments to servers. + * RequestMap is used to submit plan fragments to servers. + * Offline and realtime routing tables are used to keep track of which servers are executing the query. + * getUnavailableSegments() returns the segments that are not available when calculating the routing table. + * numPrunedSegmentsTotal() returns the number of segments that were pruned when calculating the routing table. + */ +public interface TableRouteInfo { + + @Nullable + String getOfflineTableName(); + + @Nullable + String getRealtimeTableName(); + + /** + * Gets the broker request for the offline table, if available. + * + * @return the broker request for the offline table, or null if not available + */ + @Nullable + BrokerRequest getOfflineBrokerRequest(); + + /** + * Gets the broker request for the realtime table, if available. + * + * @return the broker request for the realtime table, or null if not available + */ + @Nullable + BrokerRequest getRealtimeBrokerRequest(); + + /** + * Gets the table config for the offline table, if available. + * @return the table config for the offline table, or null if not available + */ + @Nullable + TableConfig getOfflineTableConfig(); + + /** + * Gets the table config for the realtime table, if available. + * @return the table config for the realtime table, or null if not available + */ + @Nullable + TableConfig getRealtimeTableConfig(); Review Comment: These 2 doesn't apply to logical table -- 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
