level23 / druid-client

src/Queries/QueryBuilder.php

<?php
declare(strict_types=1);

namespace Level23\Druid\Queries;

use InvalidArgumentException;
use Level23\Druid\DruidClient;
use Level23\Druid\Types\DataType;
use Level23\Druid\Concerns\HasLimit;
use Level23\Druid\Types\Granularity;
use Level23\Druid\Concerns\HasFilter;
use Level23\Druid\Concerns\HasHaving;
use Level23\Druid\Types\SortingOrder;
use Level23\Druid\Dimensions\Dimension;
use Level23\Druid\Context\QueryContext;
use Level23\Druid\Concerns\HasIntervals;
use Level23\Druid\Limits\LimitInterface;
use Level23\Druid\Concerns\HasDimensions;
use Level23\Druid\Types\OrderByDirection;
use Level23\Druid\Concerns\HasDataSource;
use Level23\Druid\Responses\QueryResponse;
use Level23\Druid\Concerns\HasAggregations;
use Level23\Druid\Context\TopNQueryContext;
use Level23\Druid\Context\ScanQueryContext;
use Level23\Druid\Concerns\HasSearchFilters;
use Level23\Druid\Concerns\HasVirtualColumns;
use Level23\Druid\Types\ScanQueryResultFormat;
use Level23\Druid\Responses\ScanQueryResponse;
use Level23\Druid\Responses\TopNQueryResponse;
use Level23\Druid\DataSources\TableDataSource;
use Level23\Druid\Context\GroupByQueryContext;
use Level23\Druid\Concerns\HasPostAggregations;
use Level23\Druid\Responses\SelectQueryResponse;
use Level23\Druid\Responses\SearchQueryResponse;
use Level23\Druid\Collections\IntervalCollection;
use Level23\Druid\Context\TimeSeriesQueryContext;
use Level23\Druid\Responses\GroupByQueryResponse;
use Level23\Druid\Collections\DimensionCollection;
use Level23\Druid\DataSources\DataSourceInterface;
use Level23\Druid\Collections\AggregationCollection;
use Level23\Druid\Responses\TimeSeriesQueryResponse;
use Level23\Druid\Collections\VirtualColumnCollection;
use Level23\Druid\Collections\PostAggregationCollection;
use Level23\Druid\Responses\SegmentMetadataQueryResponse;
use function json_encode;

class QueryBuilder
{
    use HasFilter, HasHaving, HasDimensions, HasAggregations, HasIntervals, HasLimit, HasVirtualColumns, HasPostAggregations, HasSearchFilters, HasDataSource;

The trait Level23\Druid\Concerns\HasDataSource requires the property $dataSourceName which is not provided by Level23\Druid\Queries\QueryBuilder.

    protected DruidClient $client;

    protected ?QueryBuilder $query = null;

    protected DataSourceInterface $dataSource;

    protected Granularity $granularity;

    /**
     * @var array|\Level23\Druid\PostAggregations\PostAggregatorInterface[]
     */
    protected array $postAggregations = [];

    /**
     * Set a paging identifier for a Select query.
     *
     * @var array<string,int>|null
     */
    protected ?array $pagingIdentifier = null;

    /**
     * The subtotal spec (only applies for groupBy queries)
     *
     * @var array<array<string>>
     */
    protected array $subtotals = [];

    /**
     * The metrics to select when using a Select Query.
     * When empty, all metrics are returned.
     *
     * @var array<string>
     */
    protected array $metrics = [];

    /**
     * This contains a list of "temporary" field names which we will use to store our result of
     * a virtual column when the whereFlag() method is used.
     *
     * @var array<string>
     */
    public array $placeholders = [];

    /**
     * QueryBuilder constructor.
     *
     * @param \Level23\Druid\DruidClient $client
     * @param string                     $dataSource
     * @param string|Granularity         $granularity
     */
    public function __construct(
        DruidClient $client,
        string $dataSource = '',
        string|Granularity $granularity = Granularity::ALL
    ) {
        $this->client      = $client;
        $this->query       = $this;
        $this->dataSource  = new TableDataSource($dataSource);
        $this->granularity = is_string($granularity) ? Granularity::from(strtolower($granularity)) : $granularity;
    }

    /**
     * Create a virtual column and select the result.
     *
     * Virtual columns are queryable column "views" created from a set of columns during a query.
     *
     * A virtual column can potentially draw from multiple underlying columns, although a virtual column always
     * presents itself as a single column.
     *
     * @param string          $expression
     * @param string          $as
     * @param string|DataType $outputType
     *
     * @return $this
     * @see https://druid.apache.org/docs/latest/misc/math-expr.html
     */
    public function selectVirtual(string $expression, string $as, string|DataType $outputType = DataType::STRING): self
    {
        $this->virtualColumn($expression, $as, $outputType);
        $this->select($as, $as, $outputType);

        return $this;
    }

    /**
     * Execute a druid query. We will try to detect the best possible query type possible.
     *
     * @param QueryContext|array<string,string|int|bool> $context
     *
     * @return QueryResponse
     * @throws \Level23\Druid\Exceptions\QueryResponseException
     * @throws \GuzzleHttp\Exception\GuzzleException
     */
    public function execute(array|QueryContext $context = []): QueryResponse
    {
        $query = $this->getQuery($context);

        $rawResponse = $this->client->executeQuery($query);

        return $query->parseResponse($rawResponse);
    }

    /**
     * Update/set the granularity
     *
     * @param string|Granularity $granularity
     *
     * @return $this
     */
    public function granularity(string|Granularity $granularity): QueryBuilder
    {
        $this->granularity = is_string($granularity) ? Granularity::from(strtolower($granularity)) : $granularity;

        return $this;
    }

    /**
     * Define an array which should contain arrays with dimensions where you want to retrieve the subtotals for.
     * NOTE: This only applies for groupBy queries.
     *
     * This is like doing a WITH ROLLUP in an SQL query.
     *
     * Example: Imagine that you count the number of people. You want to do this for per city, but also
     * per province, per country and per continent. This method allows you to do that all at once. Druid will
     * do the "sum(people)" per subtotal row.
     *
     * Example:
     * Array(
     *   Array('continent', 'country', 'province', 'city'),
     *   Array('continent', 'country', 'province'),
     *   Array('continent', 'country'),
     *   Array('continent'),
     * )
     *
     * @param array<array<string>> $subtotals
     *
     * @return $this
     */
    public function subtotals(array $subtotals): self
    {
        $this->subtotals = $subtotals;

        return $this;
    }

    /**
     * Select the metrics which should be returned when using a selectQuery.
     * If this is not specified, all metrics are returned (which is default).
     *
     * NOTE: This only applies to select queries!
     *
     * @param array<string> $metrics
     *
     * @return $this
     */
    public function metrics(array $metrics): self
    {
        $this->metrics = $metrics;

        return $this;
    }

    /**
     * Set a paging identifier. This is only applied for a SELECT query!
     *
     * @param array<string,int> $pagingIdentifier
     *
     * @return \Level23\Druid\Queries\QueryBuilder
     */
    public function pagingIdentifier(array $pagingIdentifier): QueryBuilder
    {
        $this->pagingIdentifier = $pagingIdentifier;

        return $this;
    }

    /**
     * Do a segment metadata query and return the response
     *
     * @return SegmentMetadataQueryResponse
     * @throws \Level23\Druid\Exceptions\QueryResponseException
     * @throws \GuzzleHttp\Exception\GuzzleException
     */
    public function segmentMetadata(): SegmentMetadataQueryResponse
    {
        $query = new SegmentMetadataQuery($this->dataSource, new IntervalCollection(...$this->intervals));

        $rawResponse = $this->client->executeQuery($query);

        return $query->parseResponse($rawResponse);
    }

    /**
     * Return the query as a JSON string
     *
     * @param QueryContext|array<string,string|int|bool> $context
     *
     * @return string
     * @throws \InvalidArgumentException if the JSON cannot be encoded.
     */
    public function toJson(array|QueryContext $context = []): string
    {
        $query = $this->getQuery($context);

        return strval(json_encode($query->toArray(), JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES));
    }

    /**
     * Return the query as an array
     *
     * @param QueryContext|array<string,string|int|bool> $context
     *
     * @return array<string,array<mixed>|string|int>
     */
    public function toArray(array|QueryContext $context = []): array
    {
        return $this->getQuery($context)->toArray();

The expression return $this->getQuery($context)->toArray() returns an array which contains values of type boolean which are incompatible with the documented value type array<mixed,mixed>|integer|string.

    }

    /**
     * Execute a TimeSeries query.
     *
     * @param array<string,string|int|bool>|TimeSeriesQueryContext $context
     *
     * @return TimeSeriesQueryResponse
     * @throws \Level23\Druid\Exceptions\QueryResponseException
     * @throws \GuzzleHttp\Exception\GuzzleException
     */
    public function timeseries(array|TimeSeriesQueryContext $context = []): TimeSeriesQueryResponse
    {
        $query = $this->buildTimeSeriesQuery($context);

        $rawResponse = $this->client->executeQuery($query);

        return $query->parseResponse($rawResponse);
    }

    /**
     * Execute a Scan Query.
     *
     * @param ScanQueryContext|array<string,string|int|bool> $context            Query context parameters
     * @param int|null                                       $rowBatchSize       How many rows buffered before return
     *                                                                           to client. Default is 20480
     * @param bool                                           $legacy             Return results consistent with the
     *                                                                           legacy "scan-query" contrib extension.
     *                                                                           Defaults to the value set by
     *                                                                           druid.query.scan.legacy, which in turn
     *                                                                           defaults to false. See Legacy mode for
     *                                                                           details.
     * @param string|ScanQueryResultFormat                   $resultFormat       Result Format. Use one of the
     *                                                                           ScanQueryResultFormat::* constants.
     *
     * @return ScanQueryResponse
     * @throws \Level23\Druid\Exceptions\QueryResponseException
     * @throws \GuzzleHttp\Exception\GuzzleException
     */
    public function scan(
        array|ScanQueryContext $context = [],
        ?int $rowBatchSize = null,
        bool $legacy = false,
        string|ScanQueryResultFormat $resultFormat = ScanQueryResultFormat::NORMAL_LIST
    ): ScanQueryResponse {
        $query = $this->buildScanQuery($context, $rowBatchSize, $legacy, $resultFormat);

        $rawResponse = $this->client->executeQuery($query);

        return $query->parseResponse($rawResponse);
    }

    /**
     * Execute a select query.
     *
     * @param QueryContext|array<string,string|int|bool> $context
     *
     * @return SelectQueryResponse
     * @throws \Level23\Druid\Exceptions\QueryResponseException
     * @throws \GuzzleHttp\Exception\GuzzleException
     */
    public function selectQuery(array|QueryContext $context = []): SelectQueryResponse
    {
        $query = $this->buildSelectQuery($context);

        $rawResponse = $this->client->executeQuery($query);

        return $query->parseResponse($rawResponse);
    }

    /**
     * Execute a topN query.
     *
     * @param array<string,string|int|bool>|TopNQueryContext $context
     *
     * @return TopNQueryResponse
     * @throws \Level23\Druid\Exceptions\QueryResponseException
     * @throws \GuzzleHttp\Exception\GuzzleException
     */
    public function topN(array|TopNQueryContext $context = []): TopNQueryResponse
    {
        $query = $this->buildTopNQuery($context);

        $rawResponse = $this->client->executeQuery($query);

        return $query->parseResponse($rawResponse);
    }

    /**
     * Return the group by query
     *
     * @param GroupByQueryContext|array<string,string|int|bool> $context
     *
     * @return GroupByQueryResponse
     * @throws \Level23\Druid\Exceptions\QueryResponseException
     * @throws \GuzzleHttp\Exception\GuzzleException
     */
    public function groupBy(array|GroupByQueryContext $context = []): GroupByQueryResponse
    {
        $query = $this->buildGroupByQuery($context);

        $rawResponse = $this->client->executeQuery($query);

        return $query->parseResponse($rawResponse);
    }

    /**
     * Execute a search query and return the response
     *
     * @param QueryContext|array<string,string|int|bool> $context
     * @param string|SortingOrder                        $sortingOrder
     *
     * @return \Level23\Druid\Responses\SearchQueryResponse
     * @throws \GuzzleHttp\Exception\GuzzleException
     * @throws \Level23\Druid\Exceptions\QueryResponseException
     */
    public function search(
        array|QueryContext $context = [],
        string|SortingOrder $sortingOrder = SortingOrder::LEXICOGRAPHIC
    ): SearchQueryResponse {
        $query = $this->buildSearchQuery($context, $sortingOrder);

        $rawResponse = $this->client->executeQuery($query);

        return $query->parseResponse($rawResponse);
    }

    /**
     * @return \Level23\Druid\DruidClient
     */
    public function getClient(): DruidClient
    {
        return $this->client;
    }

    //<editor-fold desc="Protected methods">

    /**
     * In our previous version we required an `order()` with "__time" for TimeSeries, Scan and Select Queries.
     * This method makes sure that we are backwards compatible.
     *
     * @param string|null $dimension If given, we will also check if this dimension was ordered by.
     *
     * @return bool|null
     */
    protected function legacyIsOrderByDirectionDescending(?string $dimension = null): ?bool
    {
        if ($this->limit) {
            $orderBy = $this->limit->getOrderByCollection();

            if ($orderBy->count() > 0) {
                $orderByItems = $orderBy->toArray();
                /** @var string[] $first */
                $first = reset($orderByItems);

                if ($first['dimension'] == '__time' || ($dimension && $dimension == $first['dimension'])) {
                    return $first['direction'] == OrderByDirection::DESC->value;
                }
            }
        }

        return null;
    }

    /**
     * Build a search query.
     *
     * @param QueryContext|array<string,string|int|bool> $context
     * @param string|SortingOrder                        $sortingOrder
     *
     * @return \Level23\Druid\Queries\SearchQuery
     */
    protected function buildSearchQuery(
        array|QueryContext $context = [],
        string|SortingOrder $sortingOrder = SortingOrder::LEXICOGRAPHIC
    ): SearchQuery {
        if (count($this->intervals) == 0) {
            throw new InvalidArgumentException('You have to specify at least one interval');
        }

        if (!$this->searchFilter) {
            throw new InvalidArgumentException('You have to specify a search filter!');
        }

        $query = new SearchQuery(
            $this->dataSource,
            $this->granularity,
            new IntervalCollection(...$this->intervals),
            $this->searchFilter
        );

        if (count($this->searchDimensions) > 0) {
            $query->setDimensions($this->searchDimensions);
        }

        if (is_array($context) && count($context) > 0) {
            $query->setContext(new QueryContext($context));
        } elseif ($context instanceof QueryContext) {
            $query->setContext($context);
        }

        if ($this->filter) {
            $query->setFilter($this->filter);
        }

        if ($sortingOrder) {
            $query->setSort($sortingOrder);
        }

        if ($this->limit && $this->limit->getLimit() !== null) {
            $query->setLimit($this->limit->getLimit());
        }

        return $query;
    }

    /**
     * Build a select query.
     *
     * @param QueryContext|array<string,string|int|bool> $context
     *
     * @return \Level23\Druid\Queries\SelectQuery
     */
    protected function buildSelectQuery(array|QueryContext $context = []): SelectQuery
    {
        if (count($this->intervals) == 0) {
            throw new InvalidArgumentException('You have to specify at least one interval');
        }

        if (!$this->limit || $this->limit->getLimit() === null) {
            throw new InvalidArgumentException('You have to supply a limit');
        }

        $limit = $this->limit->getLimit();

        $descending = false;
        if ($this->direction) {
            $descending = ($this->direction === OrderByDirection::DESC);
        } elseif ($this->legacyIsOrderByDirectionDescending() === true) {
            $descending = true;
        }

        $query = new SelectQuery(
            $this->dataSource,
            new IntervalCollection(...$this->intervals),
            $limit,
            count($this->dimensions) > 0 ? new DimensionCollection(...$this->dimensions) : null,
            $this->metrics,
            $descending
        );

        if ($this->pagingIdentifier) {
            $query->setPagingIdentifier($this->pagingIdentifier);
        }

        if (is_array($context) && count($context) > 0) {
            $query->setContext(new QueryContext($context));
        } elseif ($context instanceof QueryContext) {
            $query->setContext($context);
        }

        return $query;
    }

    /**
     * Build a scan query.
     *
     * @param QueryContext|array<string,string|int|bool> $context
     * @param int|null                                   $rowBatchSize
     * @param bool                                       $legacy
     * @param string|ScanQueryResultFormat               $resultFormat
     *
     * @return \Level23\Druid\Queries\ScanQuery
     */
    protected function buildScanQuery(
        array|QueryContext $context = [],
        ?int $rowBatchSize = null,
        bool $legacy = false,
        string|ScanQueryResultFormat $resultFormat = ScanQueryResultFormat::NORMAL_LIST
    ): ScanQuery {
        if (count($this->intervals) == 0) {
            throw new InvalidArgumentException('You have to specify at least one interval');
        }

        if (!$this->isDimensionsListScanCompliant()) {
            throw new InvalidArgumentException(
                'Only simple dimension or metric selects are available in a scan query. ' .
                'Aliases, extractions or lookups are not available.'
            );
        }

        $query = new ScanQuery(
            $this->dataSource,
            new IntervalCollection(...$this->intervals)
        );

        $columns = [];
        foreach ($this->dimensions as $dimension) {
            $columns[] = $dimension->getDimension();
        }

        if ($this->direction) {
            $query->setOrder($this->direction);
        } else {
            $isDescending = $this->legacyIsOrderByDirectionDescending();
            if ($isDescending !== null) {
                $query->setOrder($isDescending ? OrderByDirection::DESC : OrderByDirection::ASC);
            }
        }

        if (count($columns) > 0) {
            $query->setColumns($columns);
        }

        if (count($this->virtualColumns) > 0) {
            $query->setVirtualColumns(new VirtualColumnCollection(...$this->virtualColumns));
        }

        if ($this->filter) {
            $query->setFilter($this->filter);
        }

        if ($this->limit && $this->limit->getLimit() !== null) {
            $query->setLimit($this->limit->getLimit());
        }

        if ($this->limit && $this->limit->getOffset() !== null) {
            $query->setOffset($this->limit->getOffset());
        }

        if (is_array($context) && count($context) > 0) {
            $query->setContext(new ScanQueryContext($context));
        } elseif ($context instanceof QueryContext) {
            $query->setContext($context);
        }

        if ($resultFormat) {
            $query->setResultFormat($resultFormat);
        }

        if ($rowBatchSize !== null && $rowBatchSize > 0) {
            $query->setBatchSize($rowBatchSize);
        }

        $query->setLegacy($legacy);

        return $query;
    }

    /**
     * Build a TimeSeries query.
     *
     * @param QueryContext|array<string,string|int|bool> $context
     *
     * @return TimeSeriesQuery
     */
    protected function buildTimeSeriesQuery(array|QueryContext $context = []): TimeSeriesQuery
    {
        if (count($this->intervals) == 0) {
            throw new InvalidArgumentException('You have to specify at least one interval');
        }

        $query = new TimeSeriesQuery(
            $this->dataSource,
            new IntervalCollection(...$this->intervals),
            $this->granularity
        );

        // check if we want to use a different output name for the __time column
        $dimension = null;
        if (count($this->dimensions) == 1) {
            $dimension = $this->dimensions[0];
            // did we only retrieve the time dimension?
            if ($dimension->getDimension() == '__time' && $dimension->getOutputName() != '__time') {
                $query->setTimeOutputName($dimension->getOutputName());
            }
        }

        if (is_array($context) && count($context) > 0) {
            $query->setContext(new TimeSeriesQueryContext($context));
        } elseif ($context instanceof QueryContext) {
            $query->setContext($context);
        }

        if ($this->filter) {
            $query->setFilter($this->filter);
        }

        if (count($this->aggregations) > 0) {
            $query->setAggregations(new AggregationCollection(...$this->aggregations));
        }

        if (count($this->postAggregations) > 0) {
            $query->setPostAggregations(new PostAggregationCollection(...$this->postAggregations));
        }

        if (count($this->virtualColumns) > 0) {
            $query->setVirtualColumns(new VirtualColumnCollection(...$this->virtualColumns));
        }

        // If there is a limit set, then apply this on the time series query.
        if ($this->limit && $this->limit->getLimit() !== null) {
            $query->setLimit($this->limit->getLimit());
        }

        $descending = false;
        if ($this->direction) {
            $descending = ($this->direction === OrderByDirection::DESC);
        } elseif ($this->legacyIsOrderByDirectionDescending($dimension ? $dimension->getOutputName() : null) === true) {
            $descending = true;
        }

        $query->setDescending($descending);

        return $query;
    }

    /**
     * Build a topN query.
     *
     * @param QueryContext|array<string,string|int|bool> $context
     *
     * @return TopNQuery
     */
    protected function buildTopNQuery(array|QueryContext $context = []): TopNQuery
    {
        if (count($this->intervals) == 0) {
            throw new InvalidArgumentException('You have to specify at least one interval');
        }

        if (!$this->limit instanceof LimitInterface || $this->limit->getLimit() === null) {
            throw new InvalidArgumentException(
                'You should specify a limit to make use of a top query'
            );
        }

        $orderByCollection = $this->limit->getOrderByCollection();
        if (count($orderByCollection) == 0) {
            throw new InvalidArgumentException(
                'You should specify a an order by direction to make use of a top query'
            );
        }

        /**
         * @var \Level23\Druid\OrderBy\OrderBy $orderBy
         */
        $orderBy = $orderByCollection[0];

        $metric = $orderBy->getDimension();

        /** @var \Level23\Druid\OrderBy\OrderByInterface $orderBy */
        $query = new TopNQuery(
            $this->dataSource,
            new IntervalCollection(...$this->intervals),
            $this->dimensions[0],
            $this->limit->getLimit(),
            $metric,
            $this->granularity
        );

        $query->setDescending(
            ($orderBy->getDirection() == OrderByDirection::DESC)
        );

        if (count($this->aggregations) > 0) {
            $query->setAggregations(new AggregationCollection(...$this->aggregations));
        }

        if (count($this->postAggregations) > 0) {
            $query->setPostAggregations(new PostAggregationCollection(...$this->postAggregations));
        }

        if (count($this->virtualColumns) > 0) {
            $query->setVirtualColumns(new VirtualColumnCollection(...$this->virtualColumns));
        }

        if (is_array($context) && count($context) > 0) {
            $query->setContext(new TopNQueryContext($context));
        } elseif ($context instanceof QueryContext) {
            $query->setContext($context);
        }

        if ($this->filter) {
            $query->setFilter($this->filter);
        }

        return $query;
    }

    /**
     * Build the group by query
     *
     * @param QueryContext|array<string,string|int|bool> $context
     *
     * @return GroupByQuery
     */
    protected function buildGroupByQuery(array|QueryContext $context = []): GroupByQuery
    {
        if (count($this->intervals) == 0) {
            throw new InvalidArgumentException('You have to specify at least one interval');
        }

        $query = new GroupByQuery(
            $this->dataSource,
            new DimensionCollection(...$this->dimensions),
            new IntervalCollection(...$this->intervals),
            new AggregationCollection(...$this->aggregations),
            $this->granularity
        );

        if (is_array($context)) {

The condition is_array($context) is always true.

            $context = new GroupByQueryContext($context);
        }

        $query->setContext($context);

        if (count($this->postAggregations) > 0) {
            $query->setPostAggregations(new PostAggregationCollection(...$this->postAggregations));
        }

        if ($this->filter) {
            $query->setFilter($this->filter);
        }

        if ($this->limit) {
            $query->setLimit($this->limit);
        }

        if (count($this->virtualColumns) > 0) {
            $query->setVirtualColumns(new VirtualColumnCollection(...$this->virtualColumns));
        }

        if (count($this->subtotals) > 0) {
            $query->setSubtotals($this->subtotals);
        }

        if ($this->having) {
            $query->setHaving($this->having);
        }

        return $query;
    }

    /**
     * Return the query automatically detected based on the requested data.
     *
     * @param QueryContext|array<string,string|int|bool> $context
     *
     * @return \Level23\Druid\Queries\QueryInterface
     */
    public function getQuery(array|QueryContext $context = []): QueryInterface
    {
        // Check if this is a scan query. This is the preferred way to query when there are
        // no aggregations done.
        if ($this->isScanQuery()) {
            return $this->buildScanQuery($context);
        }

        // If we only have "grouped" by __time, then we can use a time series query.
        // This is preferred, because it's a lot faster than doing a group by query.
        if ($this->isTimeSeriesQuery()) {
            return $this->buildTimeSeriesQuery($context);
        }

        // Check if we can use a topN query.
        if ($this->isTopNQuery()) {
            return $this->buildTopNQuery($context);
        }

        // Check if we can use a select query.
        if ($this->isSelectQuery()) {
            return $this->buildSelectQuery($context);
        }

        // Check if we can use a search query.
        if ($this->isSearchQuery()) {
            return $this->buildSearchQuery($context);
        }

        return $this->buildGroupByQuery($context);
    }

    /**
     * Determine if the current query is a TimeSeries query
     *
     * @return bool
     */
    protected function isTimeSeriesQuery(): bool
    {
        if (count($this->dimensions) != 1) {
            return false;
        }

        return $this->dimensions[0]->getDimension() == '__time'
            && $this->dimensions[0] instanceof Dimension;
    }

    /**
     * Determine if the current query is topN query
     *
     * @return bool
     */
    protected function isTopNQuery(): bool
    {
        if (count($this->dimensions) != 1) {
            return false;
        }

        return $this->limit
            && $this->limit->getLimit() !== null
            && $this->limit->getOffset() === null
            && count($this->limit->getOrderByCollection()) == 1;
    }

    /**
     * Check if we should use a select query.
     *
     * @return bool
     */
    protected function isSelectQuery(): bool
    {
        return $this->pagingIdentifier !== null && count($this->aggregations) == 0;
    }

    /**
     * Check if we should use a search query.
     *
     * @return bool
     */
    protected function isSearchQuery(): bool
    {
        return !empty($this->searchFilter);
    }

    /**
     * Check if we should use a scan query.
     *
     * @return bool
     */
    protected function isScanQuery(): bool
    {
        return count($this->aggregations) == 0 && $this->isDimensionsListScanCompliant();
    }

    /**
     * Return true if the dimensions which are selected can be used as "columns" in a scan query.
     *
     * @return bool
     */
    protected function isDimensionsListScanCompliant(): bool
    {
        foreach ($this->dimensions as $dimension) {
            if (!$dimension instanceof Dimension) {
                return false;
            }

            if ($dimension->getDimension() != $dimension->getOutputName()) {
                return false;
            }
        }

        return true;
    }
    //</editor-fold>
}