Package org.apache.druid.query.topn

Class TopNQueryRunnerFactory

java.lang.Object

org.apache.druid.query.topn.TopNQueryRunnerFactory

All Implemented Interfaces:

QueryRunnerFactory<Result<TopNResultValue>,TopNQuery>

public class TopNQueryRunnerFactory
extends Object
implements QueryRunnerFactory<Result<TopNResultValue>,TopNQuery>

Constructor Summary

Constructors

Constructor	Description
TopNQueryRunnerFactory(NonBlockingPool<ByteBuffer> computationBufferPool, TopNQueryQueryToolChest toolchest, QueryWatcher queryWatcher)

Method Summary

Modifier and Type	Method	Description
QueryRunner<Result<TopNResultValue>>	createRunner(Segment segment)	Given a specific segment, this method will create a QueryRunner.
QueryToolChest<Result<TopNResultValue>,TopNQuery>	getToolchest()	Provides access to the QueryToolChest for this specific Query type.
QueryRunner<Result<TopNResultValue>>	mergeRunners(QueryProcessingPool queryProcessingPool, Iterable<QueryRunner<Result<TopNResultValue>>> queryRunners)	Runners generated with createRunner() and combined into an Iterable in (time,shardId) order are passed along to this method with an QueryProcessingPool.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.druid.query.QueryRunnerFactory

mergeRunners

Constructor Detail

TopNQueryRunnerFactory

@Inject
public TopNQueryRunnerFactory(NonBlockingPool<ByteBuffer> computationBufferPool,
                              TopNQueryQueryToolChest toolchest,
                              QueryWatcher queryWatcher)

Method Detail

createRunner

public QueryRunner<Result<TopNResultValue>> createRunner(Segment segment)

Description copied from interface: QueryRunnerFactory

Given a specific segment, this method will create a QueryRunner. The QueryRunner, when asked, will generate a Sequence of results based on the given segment. This is the meat of the Query processing and is where the results are actually generated. Everything else is just merging and reduction logic.

Specified by:

createRunner in interface QueryRunnerFactory<Result<TopNResultValue>,TopNQuery>

Parameters:

segment - The segment to process

Returns:

A QueryRunner that, when asked, will generate a Sequence of results based on the given segment

mergeRunners

public QueryRunner<Result<TopNResultValue>> mergeRunners(QueryProcessingPool queryProcessingPool,
                                                         Iterable<QueryRunner<Result<TopNResultValue>>> queryRunners)

Description copied from interface: QueryRunnerFactory

Runners generated with createRunner() and combined into an Iterable in (time,shardId) order are passed along to this method with an QueryProcessingPool. The method should then return a QueryRunner that, when asked, will use the QueryProcessingPool to run the base QueryRunners in some fashion. The vast majority of the time, this should be implemented with ChainedExecutionQueryRunner: return new ChainedExecutionQueryRunner<>(queryProcessingPool, toolChest.getOrdering(), queryWatcher, queryRunners); Which will allow for parallel execution up to the maximum number of processing threads allowed. Unlike QueryRunnerFactory.mergeRunners(ExecutorService, Iterable), this method takes a QueryProcessingPool instead which allows custom implementations for prioritize query execution on segments.

Specified by:

mergeRunners in interface QueryRunnerFactory<Result<TopNResultValue>,TopNQuery>

Parameters:

queryProcessingPool - QueryProcessingPool to be used for parallel processing

queryRunners - Individual QueryRunner objects that produce some results

Returns:

a QueryRunner that, when asked, will use the ExecutorService to run the base QueryRunner collection.

getToolchest

public QueryToolChest<Result<TopNResultValue>,TopNQuery> getToolchest()

Description copied from interface: QueryRunnerFactory

Provides access to the QueryToolChest for this specific Query type.

Specified by:

getToolchest in interface QueryRunnerFactory<Result<TopNResultValue>,TopNQuery>

Returns:

an instance of the toolchest for this specific query type.