Package org.apache.druid.query.search

Class SearchQueryQueryToolChest

    • Method Detail

      • makeMetrics

        public SearchQueryMetrics makeMetrics​(SearchQuery query)
        Description copied from class: QueryToolChest
        Creates a QueryMetrics object that is used to generate metrics for this specific query type. This exists to allow for query-specific dimensions and metrics. That is, the ToolChest is expected to set some meaningful dimensions for metrics given this query type. Examples might be the topN threshold for a TopN query or the number of dimensions included for a groupBy query.

        QueryToolChests for query types in core (druid-processing) and public extensions (belonging to the Druid source tree) should use delegate this method to GenericQueryMetricsFactory.makeMetrics(Query) on an injected instance of GenericQueryMetricsFactory, as long as they don't need to emit custom dimensions and/or metrics.

        If some custom dimensions and/or metrics should be emitted for a query type, a plan described in "Making subinterfaces of QueryMetrics" section in QueryMetrics's class-level Javadocs should be followed.

        One way or another, this method should ensure that QueryMetrics.query(Query) is called with the given query passed on the created QueryMetrics object before returning.

        Specified by:
        makeMetrics in class QueryToolChest<Result<SearchResultValue>,​SearchQuery>
        Parameters:
        query - The query that is being processed
        Returns:
        A QueryMetrics that can be used to make metrics for the provided query

      • makePreComputeManipulatorFn

        public com.google.common.base.Function<Result<SearchResultValue>,​Result<SearchResultValue>> makePreComputeManipulatorFn​(SearchQuery query,
                                                                                                                              MetricManipulationFn fn)
        Description copied from class: QueryToolChest
        Creates a Function that can take in a ResultType and return a new ResultType having applied the MetricManipulatorFn to each of the metrics.

        This function's primary purpose is to help work around some challenges that exist around deserializing results across the wire. Specifically, different aggregators will generate different object types in a result set, if we wanted jackson to be able to deserialize these directly, we'd need to generate a response class for each query that jackson could use to deserialize things. That is not what we do. Instead, we have jackson deserialize Object instances and then use a MetricManipulatorFn to convert from those object instances to the actual object that the aggregator expects. As such, this would be more effectively named "makeObjectDeserializingFn".

        It is safe and acceptable for implementations of this method to first validate that the MetricManipulationFn is MetricManipulatorFns.DESERIALIZING_INSTANCE and throw an exception if it is not. If such an exception is ever thrown, it is indicative of a bug in the caller which should be fixed by not calling this method with anything other than the deserializing manipulator function.

        There are some implementations where this was also tasked with computing PostAggregators, but this is actually not a good place to compute those as this function can be called in a number of cases when PostAggs are not really meaningful to compute. Instead, PostAggs should be computed in the mergeResults call and the mergeResults implementation should take care to ensure that PostAggs are only computed the minimum number of times necessary.

        This function is called very early in the processing pipeline on the Broker.

        Specified by:
        makePreComputeManipulatorFn in class QueryToolChest<Result<SearchResultValue>,​SearchQuery>
        Parameters:
        query - The Query that is currently being processed
        fn - The function that should be applied to all metrics in the results
        Returns:
        A function that will apply the provided fn to all metrics in the input ResultType object

      • getCacheStrategy

        public CacheStrategy<Result<SearchResultValue>,​Object,​SearchQuery> getCacheStrategy​(SearchQuery query,
                                                                                                @Nullable
                                                                                                com.fasterxml.jackson.databind.ObjectMapper objectMapper)
        Description copied from class: QueryToolChest
        Returns a CacheStrategy to be used to load data into the cache and remove it from the cache.

        This is optional. If it returns null, caching is effectively disabled for the query.

        Overrides:
        getCacheStrategy in class QueryToolChest<Result<SearchResultValue>,​SearchQuery>
        Parameters:
        query - The query whose results might be cached
        objectMapper - Object mapper to convert the deserialized generic java objects to desired types. It can be nullable to preserve backward compatibility.
        Returns:
        A CacheStrategy that can be used to populate and read from the Cache

      • preMergeQueryDecoration

        public QueryRunner<Result<SearchResultValue>> preMergeQueryDecoration​(QueryRunner<Result<SearchResultValue>> runner)
        Description copied from class: QueryToolChest
        Wraps a QueryRunner. The input QueryRunner is the QueryRunner as it exists *before* being passed to mergeResults().

        In fact, the return value of this method is always passed to mergeResults, so it is equivalent to just implement this functionality as extra decoration on the QueryRunner during mergeResults().

        In the interests of potentially simplifying these interfaces, the recommendation is to actually not override this method and instead apply anything that might be needed here in the mergeResults() call.

        Overrides:
        preMergeQueryDecoration in class QueryToolChest<Result<SearchResultValue>,​SearchQuery>
        Parameters:
        runner - The runner to be wrapped
        Returns:
        The wrapped runner