Package org.apache.pinot.broker.routing

Class BrokerRoutingManager

java.lang.Object

org.apache.pinot.broker.routing.BrokerRoutingManager

All Implemented Interfaces:

ClusterChangeHandler, RoutingManager

public class BrokerRoutingManager
extends Object
implements RoutingManager, ClusterChangeHandler

The RoutingManager manages the routing of all tables hosted by the broker instance. It listens to the cluster changes and updates the routing components accordingly.

The following methods are provided:

• buildRouting(String): Builds/rebuilds the routing for a table
• removeRouting(String): Removes the routing for a table
• refreshSegment(String, String): Refreshes the metadata for a segment
• routingExists(String): Returns whether the routing exists for a table
• getRoutingTable(BrokerRequest, long): Returns the routing table for a query
• getTimeBoundaryInfo(String): Returns the time boundary info for a table
• getQueryTimeoutMs(String): Returns the table-level query timeout in milliseconds for a table

TODO: Expose RoutingEntry class to get a consistent view in the broker request handler and save the redundant map lookups.

Constructor Summary

Constructors

Constructor	Description
BrokerRoutingManager(org.apache.pinot.common.metrics.BrokerMetrics brokerMetrics, ServerRoutingStatsManager serverRoutingStatsManager, org.apache.pinot.spi.env.PinotConfiguration pinotConfig)

Method Summary

Modifier and Type	Method	Description
void	buildRouting(String tableNameWithType)	Builds/rebuilds the routing for the given table.
void	excludeServerFromRouting(String instanceId)	Excludes a server from the routing.
Map<String,ServerInstance>	getEnabledServerInstanceMap()
Long	getQueryTimeoutMs(String tableNameWithType)	Returns the table-level query timeout in milliseconds for the given table, or null if the timeout is not configured in the table config.
RoutingTable	getRoutingTable(org.apache.pinot.common.request.BrokerRequest brokerRequest, long requestId)	Returns the routing table (a map from server instance to list of segments hosted by the server, and a list of unavailable segments) based on the broker request, or null if the routing does not exist.
TimeBoundaryInfo	getTimeBoundaryInfo(String offlineTableName)	Returns the time boundary info for the given offline table, or null if the routing or time boundary does not exist.
void	includeServerToRouting(String instanceId)	Includes a previous excluded server to the routing.
void	init(org.apache.helix.HelixManager helixManager)	Initializes the cluster change handler with the given connected Helix manager.
void	processClusterChange(org.apache.helix.HelixConstants.ChangeType changeType)	Processes the cluster change of the given type (e.g.
void	refreshSegment(String tableNameWithType, String segment)	Refreshes the metadata for the given segment (called when segment is getting refreshed).
void	removeRouting(String tableNameWithType)	Removes the routing for the given table.
boolean	routingExists(String tableNameWithType)	Returns true if the routing exists for the given table.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BrokerRoutingManager

public BrokerRoutingManager(org.apache.pinot.common.metrics.BrokerMetrics brokerMetrics,
                            ServerRoutingStatsManager serverRoutingStatsManager,
                            org.apache.pinot.spi.env.PinotConfiguration pinotConfig)

Method Detail

init

public void init(org.apache.helix.HelixManager helixManager)

Description copied from interface: ClusterChangeHandler

Initializes the cluster change handler with the given connected Helix manager.

Specified by:

init in interface ClusterChangeHandler

processClusterChange

public void processClusterChange(org.apache.helix.HelixConstants.ChangeType changeType)

Description copied from interface: ClusterChangeHandler

Processes the cluster change of the given type (e.g. EXTERNAL_VIEW, INSTANCE_CONFIG, LIVE_INSTANCE).

Specified by:

processClusterChange in interface ClusterChangeHandler

excludeServerFromRouting

public void excludeServerFromRouting(String instanceId)

Excludes a server from the routing.

includeServerToRouting

public void includeServerToRouting(String instanceId)

Includes a previous excluded server to the routing.

buildRouting

public void buildRouting(String tableNameWithType)

Builds/rebuilds the routing for the given table.

removeRouting

public void removeRouting(String tableNameWithType)

Removes the routing for the given table.

refreshSegment

public void refreshSegment(String tableNameWithType,
                           String segment)

Refreshes the metadata for the given segment (called when segment is getting refreshed).

routingExists

public boolean routingExists(String tableNameWithType)

Returns true if the routing exists for the given table.

Specified by:

routingExists in interface RoutingManager

getRoutingTable

@Nullable
public RoutingTable getRoutingTable(org.apache.pinot.common.request.BrokerRequest brokerRequest,
                                    long requestId)

Returns the routing table (a map from server instance to list of segments hosted by the server, and a list of unavailable segments) based on the broker request, or null if the routing does not exist.

NOTE: The broker request should already have the table suffix (_OFFLINE or _REALTIME) appended.

Specified by:

getRoutingTable in interface RoutingManager

getEnabledServerInstanceMap

public Map<String,ServerInstance> getEnabledServerInstanceMap()

Specified by:

getEnabledServerInstanceMap in interface RoutingManager

getTimeBoundaryInfo

@Nullable
public TimeBoundaryInfo getTimeBoundaryInfo(String offlineTableName)

Returns the time boundary info for the given offline table, or null if the routing or time boundary does not exist.

NOTE: Time boundary info is only available for the offline part of the hybrid table.

Specified by:

getTimeBoundaryInfo in interface RoutingManager

getQueryTimeoutMs

@Nullable
public Long getQueryTimeoutMs(String tableNameWithType)

Returns the table-level query timeout in milliseconds for the given table, or null if the timeout is not configured in the table config.