io.druid.query.QueryRunnerFactory Maven / Gradle / Ivy

/*
 * Licensed to Metamarkets Group Inc. (Metamarkets) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. Metamarkets 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 io.druid.query;

import io.druid.guice.annotations.ExtensionPoint;
import io.druid.segment.Segment;

import java.util.concurrent.ExecutorService;

/**
 * An interface that defines the nitty gritty implementation detauls of a Query on a Segment
 */
@ExtensionPoint
public 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.
   *
   * @param segment The segment to process
   * @return A QueryRunner that, when asked, will generate a Sequence of results based on the given segment
   */
  public QueryRunner createRunner(Segment segment);

  /**
   * Runners generated with createRunner() and combined into an Iterable in (time,shardId) order are passed
   * along to this method with an ExecutorService.  The method should then return a QueryRunner that, when
   * asked, will use the ExecutorService to run the base QueryRunners in some fashion.
   *
   * The vast majority of the time, this should be implemented with
   *
   *     return new ChainedExecutionQueryRunner<>(
   *         queryExecutor, toolChest.getOrdering(), queryWatcher, queryRunners
   *     );
   *
   * Which will allow for parallel execution up to the maximum number of processing threads allowed.
   *
   * @param queryExecutor ExecutorService to be used for parallel processing
   * @param queryRunners Individual QueryRunner objects that produce some results
   * @return a QueryRunner that, when asked, will use the ExecutorService to run the base QueryRunners
   */
  public QueryRunner mergeRunners(ExecutorService queryExecutor, Iterable> queryRunners);

  /**
   * Provides access to the toolchest for this specific query type.
   *
   * @return an instance of the toolchest for this specific query type.
   */
  public QueryToolChest getToolchest();
}