Level23\Druid\Concerns\HasVirtualColumns

Complexity

Total Complexity

1

Size/Duplication

Total Lines	32
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	3
Bugs	1	Features	0

1 Method

Rating	Name	Duplication	Size	Complexity
A	virtualColumn()	0	5	1

<?php

declare(strict_types=1);

namespace Level23\Druid\Concerns;

use Level23\Druid\Types\DataType;
use Level23\Druid\VirtualColumns\VirtualColumn;

trait HasVirtualColumns
{
    /**
     * @var array|\Level23\Druid\VirtualColumns\VirtualColumnInterface[]
     */
    protected array $virtualColumns = [];

    /**
     * Create a virtual column.
     *
     * 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.
     *
     * Virtual columns can be used as dimensions or as inputs to aggregators.
     *
     * NOTE: virtual columns are NOT automatically added to your output. You should select it separately if you want to
     * add it also to your output. Use selectVirtual to do both at once.
     *
     * @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 virtualColumn(string $expression, string $as, string|DataType $outputType = DataType::STRING): self
    {
        $this->virtualColumns[] = new VirtualColumn($expression, $as, $outputType);

        return $this;
    }
}