Packages

case class Dim extends Named[Dim] with Product with Serializable

This class represents a single dimension in a Druid datasource, along with all operations that can be performed in a query (e.g., filtering, aggregation, post-aggregation, etc.).

Linear Supertypes
Serializable, Product, Equals, Named[Dim], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Dim
  2. Serializable
  3. Product
  4. Equals
  5. Named
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def *(v: Dim): ArithmeticPostAgg

    Arithmetic multiplication post-aggregator

  4. def *(v: Double): ArithmeticPostAgg

    Arithmetic multiplication post-aggregator

  5. def +(v: Dim): ArithmeticPostAgg

    Arithmetic addition post-aggregator

  6. def +(v: Double): ArithmeticPostAgg

    Arithmetic addition post-aggregator

  7. def -(v: Dim): ArithmeticPostAgg

    Arithmetic subtraction post-aggregator

  8. def -(v: Double): ArithmeticPostAgg

    Arithmetic subtraction post-aggregator

  9. def /(v: Dim): ArithmeticPostAgg

    Arithmetic division post-aggregator, that always returns 0 when dividing by 0, regardless of the numerator

  10. def /(v: Double): ArithmeticPostAgg

    Arithmetic division post-aggregator, that always returns 0 when dividing by 0, regardless of the numerator

  11. def <(value: String): Bound

    Filter based on a upper bound of dimension values, using lexicographic ordering.

    Filter based on a upper bound of dimension values, using lexicographic ordering.

    returns

    a bound filtering expression, with lexicographic ordering, specifying that the value of the dimension should be less than the given number.

  12. def <(value: Double): FilteringExpression

    Filter based on a strict upper bound of dimension values, using numeric ordering.

    Filter based on a strict upper bound of dimension values, using numeric ordering.

    returns

    a bound filtering expression, with numeric ordering, specifying that the value of the dimension should be less than the given number.

  13. def <=(value: String): Bound

    Filter based on a strict upper bound of dimension values, using lexicographic ordering.

    Filter based on a strict upper bound of dimension values, using lexicographic ordering.

    returns

    a bound filtering expression, with lexicographic ordering, specifying that the value of the dimension should be less than, or equal to the given number.

  14. def <=(value: Double): FilteringExpression

    Filter based on an upper bound of dimension values, using numeric ordering.

    Filter based on an upper bound of dimension values, using numeric ordering.

    returns

    a bound filtering expression, with numeric ordering, specifying that the value of the dimension should be less than, or equal to the given number.

  15. def =!=(value: Long): FilteringExpression
  16. def =!=(value: Double): FilteringExpression

    returns

    a filtering expression of not equals (numeric)

  17. def =!=(value: String): FilteringExpression

    returns

    a filtering expression of not equals (string)

  18. def =!=(other: Dim): FilteringExpression

    returns

    negated column-comparison filtering expression between this and the specified dimensions.

  19. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  20. def ===(value: Long): FilteringExpression
  21. def ===(value: Double): FilteringExpression

    returns

    a filtering expression of value equals (numeric)

  22. def ===(value: String): FilteringExpression

    returns

    a filtering expression of value equals (string)

  23. def ===(other: Dim): FilteringExpression

    returns

    column-comparison filtering expression between this and the specified dimensions.

  24. def >(value: String): Bound

    Filter based on a lower bound of dimension values, using lexicographic ordering.

    Filter based on a lower bound of dimension values, using lexicographic ordering.

    returns

    a bound filtering expression, with lexicographic ordering, specifying that the value of the dimension should be greater than the given number.

  25. def >(value: Double): FilteringExpression

    Filter based on a strict lower bound of dimension values, using numeric ordering.

    Filter based on a strict lower bound of dimension values, using numeric ordering.

    returns

    a bound filtering expression, with numeric ordering, specifying that the value of the dimension should be greater than the given number.

  26. def >=(value: String): Bound

    Filter based on a strict lower bound of dimension values, using lexicographic ordering.

    Filter based on a strict lower bound of dimension values, using lexicographic ordering.

    returns

    a bound filtering expression, with lexicographic ordering, specifying that the value of the dimension should be greater than, or equal to the given number.

  27. def >=(value: Double): FilteringExpression

    Filter based on a lower bound of dimension values, using numeric ordering.

    Filter based on a lower bound of dimension values, using numeric ordering.

    returns

    a bound filtering expression, with numeric ordering, specifying that the value of the dimension should be greater than, or equal to the given number.

  28. def alias(name: String): Dim

    Sets an alias of the dimension

    Sets an alias of the dimension

    returns

    the resulting dimension with the given name

    Definition Classes
    Dim → Named
  29. def as(name: String): Dim
    Definition Classes
    Named
  30. def asFloat: Dim

    returns

    this dimension with FLOAT as output type

  31. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  32. def asLong: Dim

    returns

    this dimension with LONG as output type

  33. def asString: Dim

    returns

    this dimension with STRING as output type

  34. def asc(orderType: DimensionOrderType): OrderByColumnSpec

    Set column ascending direction, using the specified ordering

  35. def asc: OrderByColumnSpec

    Set column ascending direction, using lexicographic ordering

  36. def between(lower: String, upper: String): Bound

    Filter on ranges of dimension values, using lexicographic ordering, where lower and upper bounds are non-strict.

    Filter on ranges of dimension values, using lexicographic ordering, where lower and upper bounds are non-strict.

    lower

    the lower bound

    upper

    the upper bound

    returns

    a bound filtering expression, with lexicographic ordering, where each bound is not-strict

  37. def between(lower: String, upper: String, lowerStrict: Boolean, upperStrict: Boolean): Bound

    Filter on ranges of dimension values, using lexicographic ordering.

    Filter on ranges of dimension values, using lexicographic ordering.

    lower

    the lower bound

    upper

    the upper bound

    lowerStrict

    Perform strict comparison on the lower bound ("<" instead of "<=")

    upperStrict

    Perform strict comparison on the upper bound (">" instead of ">=")

    returns

    a bound filtering expression, with lexicographic ordering

  38. def between(lower: Double, upper: Double): Bound

    Filter on ranges of dimension values, using numeric ordering, where lower and upper bounds are non-strict.

    Filter on ranges of dimension values, using numeric ordering, where lower and upper bounds are non-strict.

    lower

    the lower bound

    upper

    the upper bound

    returns

    a bound filtering expression, with numeric ordering, where each bound is not-strict

  39. def between(lower: Double, upper: Double, lowerStrict: Boolean, upperStrict: Boolean): Bound

    Filter on ranges of dimension values, using numeric ordering.

    Filter on ranges of dimension values, using numeric ordering.

    lower

    the lower bound

    upper

    the upper bound

    lowerStrict

    Perform strict comparison on the lower bound ("<" instead of "<=")

    upperStrict

    Perform strict comparison on the upper bound (">" instead of ">=")

    returns

    a bound filtering expression, with numeric ordering

  40. def build(): Dimension

    returns

    the resulting instance of Dimension. When extractionFn is set, then give an instance of ExtractionDimension, otherwise DefaultDimension.

    Attributes
    protected[dql]
  41. def cast(outputType: DimType): Dim
  42. def cast(outputType: String): Dim

    Set the output type of the dimension.

    Set the output type of the dimension. In can be any of STRING, LONG or FLOAT.

    outputType

    the output type (STRING, LONG or FLOAT.)

    returns

    the dimension having set the specified output type

  43. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  44. def contains(value: String, caseSensitive: Boolean = true): FilteringExpression

    Filter on partial string matches

    Filter on partial string matches

    value

    the value to search

    caseSensitive

    enable/disable case-sensitive search

    returns

    the search filtering expression

  45. def containsIgnoreCase(value: String): FilteringExpression

    Filter on partial string matches, with ignore case search

    Filter on partial string matches, with ignore case search

    returns

    the search filtering expression

  46. def containsInsensitive(value: String): FilteringExpression

    Filter on partial string matches, with ignore case search

    Filter on partial string matches, with ignore case search

    returns

    the search filtering expression

  47. def count: AggregationExpression

    Aggregation to count the number of rows

    Aggregation to count the number of rows

    Please note the count aggregator counts the number of Druid rows, which does not always reflect the number of raw events ingested. This is because Apache Druid can be configured to roll up data at ingestion time.

    To count the number of ingested rows of data, include a count aggregator at ingestion time, and a longSum aggregator at query time.

  48. def desc(orderType: DimensionOrderType): OrderByColumnSpec

    Set column descending direction, using the specified ordering

  49. def desc: OrderByColumnSpec

    Set column descending direction, using lexicographic ordering

  50. def doubleFirst: AggregationExpression

    Aggregation to compute the metric value with the minimum timestamp or 0 if no row exist

  51. def doubleLast: AggregationExpression

    Aggregation to compute the metric value with the maximum timestamp or 0 if no row exist

  52. def doubleMax: AggregationExpression

    Aggregation to compute the maximum of all metric values and Double.NEGATIVE_INFINITY

  53. def doubleMin: AggregationExpression

    Aggregation to compute the minimum of all metric values and Double.POSITIVE_INFINITY

  54. def doubleSum: AggregationExpression

    Aggregation to compute the sum of values (as a 64-bit floating point value)

  55. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  56. def extract(fn: ExtractionFn): Dim

    Set an extraction function

    Set an extraction function

    fn

    the extraction function to use (see ExtractionFn)

  57. val extractionFnOpt: Option[ExtractionFn]
  58. def floatFirst: AggregationExpression

    Aggregation to compute the metric value with the minimum timestamp or 0 if no row exist

  59. def floatLast: AggregationExpression

    Aggregation to compute the metric value with the maximum timestamp or 0 if no row exist

  60. def floatMax: AggregationExpression

    Aggregation to compute the maximum of all metric values and Float.NEGATIVE_INFINITY

  61. def floatMin: AggregationExpression

    Aggregation to compute the minimum of all metric values and Float.POSITIVE_INFINITY

  62. def floatSum: AggregationExpression

    Aggregation to compute the sum of values (as a 32-bit floating point value)

  63. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  64. def getName: String

    returns

    the name of the dimension

    Definition Classes
    Dim → Named
  65. def hyperUnique: HyperUniqueAgg

    Aggregation to compute the estimated cardinality of a dimension that has been aggregated as a "hyperUnique" metric at indexing time.

  66. def hyperUniqueCardinality: HyperUniqueCardinalityPostAgg

    HyperUnique Cardinality post-aggregator

  67. def in[T](values: Iterable[T])(implicit arg0: Numeric[T]): InNumeric[T]
  68. def in[T](value: T, values: T*)(implicit arg0: Numeric[T]): FilteringExpression
  69. def in(values: Iterable[String]): In
  70. def in(value: String, values: String*): FilteringExpression

    returns

    in-filter of this dimension for the specified values

  71. def inFiltered(aggregator: AggregationExpression, values: Iterable[String]): AggregationExpression
  72. def inFiltered(aggregator: AggregationExpression, first: String, rest: String*): AggregationExpression

    Wraps any given aggregator, but only aggregates the values for which the given dimension filter matches, by using the in filter.

    Wraps any given aggregator, but only aggregates the values for which the given dimension filter matches, by using the in filter.

    aggregator

    the aggregator to wrap

    first

    the value to filter

    rest

    the rest values to filter (when are more than one values to filter)

  73. def interval(value: String): FilteringExpression

    Performs range filtering on columns that contain long millisecond values, the boundary specified as ISO 8601 time interval

    Performs range filtering on columns that contain long millisecond values, the boundary specified as ISO 8601 time interval

    returns

    the interval filtering expression

  74. def intervals(values: Iterable[String]): FilteringExpression
  75. def intervals(first: String, second: String, rest: String*): FilteringExpression

    Performs range filtering on columns that contain long millisecond values, the boundaries specified as ISO 8601 time intervals

    Performs range filtering on columns that contain long millisecond values, the boundaries specified as ISO 8601 time intervals

    returns

    the interval filtering expression

  76. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  77. def isNotNull: FilteringExpression

    returns

    selector expression stating that the contents of the dimension should not be null

  78. def isNull: FilteringExpression

    returns

    selector expression stating that the contents of the dimension should be null

  79. def like(pattern: String): FilteringExpression

    returns

    like-filter of this dimension for the specified LIKE pattern

  80. def longFirst: AggregationExpression

    Aggregation to compute the metric value with the minimum timestamp or 0 if no row exist

  81. def longLast: AggregationExpression

    Aggregation to compute the metric value with the maximum timestamp or 0 if no row exist

  82. def longMax: AggregationExpression

    Aggregation to compute the maximum of all metric values and Long.MAX_VALUE

  83. def longMin: AggregationExpression

    Aggregation to compute the minimum of all metric values and Long.MIN_VALUE

  84. def longSum: AggregationExpression

    Aggregation to compute the sum of values (as a 64-bit signed integer)

  85. val name: String
  86. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  87. def notIn[T](values: Iterable[T])(implicit arg0: Numeric[T]): FilteringExpression
  88. def notIn[T](value: T, values: T*)(implicit arg0: Numeric[T]): FilteringExpression
  89. def notIn(values: Iterable[String]): FilteringExpression
  90. def notIn(value: String, values: String*): FilteringExpression

    returns

    negated in-filter of this dimension for the specified values

  91. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  92. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  93. val outputNameOpt: Option[String]
  94. val outputTypeOpt: Option[String]
  95. def productElementNames: Iterator[String]
    Definition Classes
    Product
  96. def quotient(v: Dim): ArithmeticPostAgg

    Arithmetic division post-aggregator

  97. def quotient(v: Double): ArithmeticPostAgg

    Arithmetic division post-aggregator

  98. def regex(pattern: String): FilteringExpression

    returns

    regex-filter of this dimension for the specified Java regular expression pattern

  99. def selectorFiltered(aggregator: AggregationExpression, value: String): SelectorFilteredAgg

    Wraps any given aggregator, but only aggregates the values for which the given dimension filter matches, by using the selector filter.

    Wraps any given aggregator, but only aggregates the values for which the given dimension filter matches, by using the selector filter.

    aggregator

    the aggregator to wrap

    value

    the values to select

  100. def selectorFiltered(aggregator: AggregationExpression): SelectorFilteredAgg

    Wraps any given aggregator

    Wraps any given aggregator

    aggregator

    the aggregator to wrap

  101. def stringFirst: AggregationExpression

    Aggregation to compute the metric value with the minimum timestamp or null if no row exist

  102. def stringLast: AggregationExpression

    Aggregation to compute the metric value with the maximum timestamp or null if no row exist

  103. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  104. def thetaSketch: ThetaSketchAgg

    Aggregation to compute theta-sketches

  105. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  106. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  107. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  108. def within(coords: Iterable[Double], distance: Double, unit: Unit = Distance.DistanceUnit.DEGREES): FilteringExpression

    Filter spatially indexed columns by specifying the origin coordinates and a distance

    Filter spatially indexed columns by specifying the origin coordinates and a distance

    coords

    a list of origin coordinates in the form [x, y, z, ...]

    distance

    the distance from origin coordinates. It can be specified in kilometers, miles or radius degrees (default)

    returns

    the resulting spatial filtering expression

  109. def within(minCoords: Iterable[Double], maxCoords: Iterable[Double]): FilteringExpression

    Filter spatially indexed columns by specifying the bounds of minimum and maximum coordinates

    Filter spatially indexed columns by specifying the bounds of minimum and maximum coordinates

    minCoords

    a list of minimum dimension coordinates for coordinates [x, y, z, ...]

    maxCoords

    a list of maximum dimension coordinates for coordinates [x, y, z, ...]

    returns

    the resulting spatial filtering expression

Deprecated Value Members

  1. def =<(value: String): Bound

    Filter based on a strict upper bound of dimension values, using lexicographic ordering.

    Filter based on a strict upper bound of dimension values, using lexicographic ordering.

    returns

    a bound filtering expression, with lexicographic ordering, specifying that the value of the dimension should be less than, or equal to the given number.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.4.0)

  2. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Named[Dim]

Inherited from AnyRef

Inherited from Any

Ungrouped