wow-api/me.ahoo.wow.api.query.descriptor/AnalysisDescriptor

AnalysisDescriptor

data class AnalysisDescriptor(val metrics: List<String>, val approximate: List<String>, val expressions: Boolean, val having: HavingDescriptor, val sort: AnalysisSortDescriptor, val dense: Boolean, val dateUnits: List<AggregationDateUnit>, val dateParts: List<AggregationDatePart>, val dateDiffUnits: List<DateDiffUnit>, val firstLastOrderBy: String? = null, val windows: List<WindowFunction> = emptyList(), val rootGroups: Boolean = false)

Constructors

AnalysisDescriptor

constructor(metrics: List<String>, approximate: List<String>, expressions: Boolean, having: HavingDescriptor, sort: AnalysisSortDescriptor, dense: Boolean, dateUnits: List<AggregationDateUnit>, dateParts: List<AggregationDatePart>, dateDiffUnits: List<DateDiffUnit>, firstLastOrderBy: String? = null, windows: List<WindowFunction> = emptyList(), rootGroups: Boolean = false)

Properties

val approximate: List<String>

The metrics whose results this backend estimates rather than computes exactly.

val dateDiffUnits: List<DateDiffUnit>

The units a DATE_DIFF expression may measure in; empty when expressions is false.

val dateParts: List<AggregationDatePart>

The calendar parts a DATE_PART group may group by.

val dateUnits: List<AggregationDateUnit>

The calendar units a DATE_HISTOGRAM group may bucket by.

val dense: Boolean

val expressions: Boolean

Whether computed expressions (arithmetic and DATE_DIFF) may feed metrics and TERMS / HISTOGRAM groups, and be compared by an EXPRESSION filter. A DATE_DIFF operand is any field whose aggregate.groups lists DATE_HISTOGRAM.

firstLastOrderBy

val firstLastOrderBy: String?

The field FIRST and LAST order by when they name no orderBy, at the record level; null when the model has no event time or the storage offers no FIRST / LAST. An explicit orderBy is any single-valued field whose sort.paged is true in the metric's scope.

val having: HavingDescriptor

val metrics: List<String>

val rootGroups: Boolean

Whether a group of a query that expands elements may read a root field (scope: ROOT); false where the storage cannot group elements by their record's fields.

val sort: AnalysisSortDescriptor

val windows: List<WindowFunction>

The window functions a derived metric may compute over the groups; empty when DERIVED is not offered.