SimpleGroupByQueryParameters

Extends \DruidFamiliar\Abstracts\AbstractTaskParameters Implements \DruidFamiliar\Interfaces\IDruidQueryParameters

Class SimpleGroupByQueryParameters represents parameter values for a typical group by Druid query.

Class AbstractTaskParameters

package

DruidFamiliar

Methods

getIntervals

getIntervals() : \DruidFamiliar\Interval

isValid

isValid() : boolean
inherited

Response

boolean

Configure the aggregators for this request.

setAggregators( $aggregatorsArray) 

Arguments

$aggregatorsArray

array PHP Array of aggregators

setFilePath

setFilePath( $path) 

Arguments

$path

Configure the filters for this request.

setFilters( $filtersArray) 

Arguments

$filtersArray

PHP Array of aggregators

setIntervalByStartAndEnd

setIntervalByStartAndEnd(string|\DateTime|\DruidFamiliar\DruidTime $intervalStart, string|\DateTime|\DruidFamiliar\DruidTime $intervalEnd) 

Arguments

$intervalStart

string|\DateTime|\DruidFamiliar\DruidTime

$intervalEnd

string|\DateTime|\DruidFamiliar\DruidTime

Adjusts the datetime to make the interval "exclusive" of the datetime.

setIntervalForQueryingUsingExclusiveTimes( $startDateTime,  $endDateTime) : void

e.g., given startDateTime=2014-06-18T12:30:01Z and endDateTime=2014-06-18T01:00:00Z return and Interval containing startDateTime=2014-06-18T12:30:00Z and endDateTime=2014-06-18T01:00:01Z

Arguments

$startDateTime

$endDateTime

setIntervals

setIntervals(\DruidFamiliar\Interval $intervals) 

Arguments

Configure the post aggregators for this request.

setPostAggregators( $postAggregatorsArray) 

Arguments

$postAggregatorsArray

array PHP Array of post aggregators

validate

validate() 
throws

validateForEmptyParameters

validateForEmptyParameters() 
throws

validateForMissingParameters

validateForMissingParameters() 
throws

Properties

Query Type

queryType : string
var

Type(s)

string

intervals

intervals : \DruidFamiliar\Interval

granularityType

granularityType : string
var

Type(s)

string

granularity

granularity : string
var

Type(s)

string

DataSource Name

dataSource : string
var

Type(s)

string

The data's time dimension key.

timeDimension : string
var

Type(s)

string

Array of strings representing the data's non-time dimensions' keys.

dimensions : array
var

Type(s)

array

Array of json encoded strings

filters : array

Intended to be set through $this->setFilters(...).

var

Type(s)

array

Array of json encoded strings

aggregators : array

Intended to be set through $this->setAggregators(...).

var

Type(s)

array

Array of json encoded strings

postAggregators : array

Intended to be set through $this->setPostAggregators(...).

var

Type(s)

array