c

ai.chronon.api

Aggregation

class Aggregation extends TBase[Aggregation, _Fields] with Serializable with Cloneable with Comparable[Aggregation]

Chronon provides a powerful aggregations primitive - that takes the familiar aggregation operation, via groupBy in SQL and extends it with three things - windowing, bucketing and auto-explode.

:param inputColumn: The column as specified in source.query.selects - on which we need to aggregate with.

:param operation: The type of aggregation that needs to be performed on the inputColumn.

:param argMap: Extra arguments that needs to be passed to some of the operations like LAST_K, APPROX_PERCENTILE.

:param windows: For TEMPORAL case windows are sawtooth. Meaning head slides ahead continuously in time, whereas, the tail only hops ahead, at discrete points in time. Hop is determined by the window size automatically. The maximum hop size is 1/12 of window size. You can specify multiple such windows at once.

Window > 12 days -> Hop Size = 1 day

Window > 12 hours -> Hop Size = 1 hr

Window > 1hr -> Hop Size = 5 minutes

:param buckets: This is an additional layer of aggregation. You can key a group_by by user, and bucket a "item_view" count by "item_category". This will produce one row per user, with column containing map of "item_category" to "view_count". You can specify multiple such buckets at once.

Annotations
@SuppressWarnings() @Generated()
Linear Supertypes
Cloneable, TBase[Aggregation, _Fields], Serializable, TSerializable, Comparable[Aggregation], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Aggregation
  2. Cloneable
  3. TBase
  4. Serializable
  5. TSerializable
  6. Comparable
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Aggregation(other: Aggregation)

    Performs a deep copy on other.

  2. new Aggregation()

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addToBuckets(elem: String): Unit
  5. def addToWindows(elem: Window): Unit
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clear(): Unit
    Definition Classes
    Aggregation → TBase
    Annotations
    @Override()
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  9. def compareTo(other: Aggregation): Int
    Definition Classes
    Aggregation → Comparable
    Annotations
    @Override()
  10. def deepCopy(): Aggregation
    Definition Classes
    Aggregation → TBase
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(that: Aggregation): Boolean
  13. def equals(that: Any): Boolean
    Definition Classes
    Aggregation → AnyRef → Any
    Annotations
    @Override()
  14. def fieldForId(fieldId: Int): _Fields
    Definition Classes
    Aggregation → TBase
    Annotations
    @Nullable()
  15. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. def getArgMap(): Map[String, String]
    Annotations
    @Nullable()
  17. def getArgMapSize(): Int
  18. def getBuckets(): List[String]

    This is an additional layer of aggregation.

    This is an additional layer of aggregation. You can key a group_by by user, and bucket a “item_view” count by “item_category”. This will produce one row per user, with column containing map of “item_category” to “view_count”. You can specify multiple such buckets at once

    Annotations
    @Nullable()
  19. def getBucketsIterator(): Iterator[String]
    Annotations
    @Nullable()
  20. def getBucketsSize(): Int
  21. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  22. def getFieldValue(field: _Fields): AnyRef
    Definition Classes
    Aggregation → TBase
    Annotations
    @Nullable()
  23. def getInputColumn(): String
    Annotations
    @Nullable()
  24. def getOperation(): Operation

    Annotations
    @Nullable()
    See also

    Operation

  25. def getWindows(): List[Window]
    Annotations
    @Nullable()
  26. def getWindowsIterator(): Iterator[Window]
    Annotations
    @Nullable()
  27. def getWindowsSize(): Int
  28. def hashCode(): Int
    Definition Classes
    Aggregation → AnyRef → Any
    Annotations
    @Override()
  29. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  30. def isSet(field: _Fields): Boolean

    Returns true if field corresponding to fieldID is set (has been assigned a value) and false otherwise

    Returns true if field corresponding to fieldID is set (has been assigned a value) and false otherwise

    Definition Classes
    Aggregation → TBase
  31. def isSetArgMap(): Boolean

    Returns true if field argMap is set (has been assigned a value) and false otherwise

  32. def isSetBuckets(): Boolean

    Returns true if field buckets is set (has been assigned a value) and false otherwise

  33. def isSetInputColumn(): Boolean

    Returns true if field inputColumn is set (has been assigned a value) and false otherwise

  34. def isSetOperation(): Boolean

    Returns true if field operation is set (has been assigned a value) and false otherwise

  35. def isSetWindows(): Boolean

    Returns true if field windows is set (has been assigned a value) and false otherwise

  36. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  37. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  38. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  39. def putToArgMap(key: String, val: String): Unit
  40. def read(iprot: TProtocol): Unit
    Definition Classes
    Aggregation → TSerializable
  41. def setArgMap(argMap: Map[String, String]): Aggregation
  42. def setArgMapIsSet(value: Boolean): Unit
  43. def setBuckets(buckets: List[String]): Aggregation

    This is an additional layer of aggregation.

    This is an additional layer of aggregation. You can key a group_by by user, and bucket a “item_view” count by “item_category”. This will produce one row per user, with column containing map of “item_category” to “view_count”. You can specify multiple such buckets at once

  44. def setBucketsIsSet(value: Boolean): Unit
  45. def setFieldValue(field: _Fields, value: Any): Unit
    Definition Classes
    Aggregation → TBase
  46. def setInputColumn(inputColumn: String): Aggregation
  47. def setInputColumnIsSet(value: Boolean): Unit
  48. def setOperation(operation: Operation): Aggregation

    See also

    Operation

  49. def setOperationIsSet(value: Boolean): Unit
  50. def setWindows(windows: List[Window]): Aggregation
  51. def setWindowsIsSet(value: Boolean): Unit
  52. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  53. def toString(): String
    Definition Classes
    Aggregation → AnyRef → Any
    Annotations
    @Override()
  54. def unsetArgMap(): Unit
  55. def unsetBuckets(): Unit
  56. def unsetInputColumn(): Unit
  57. def unsetOperation(): Unit
  58. def unsetWindows(): Unit
  59. def validate(): Unit
  60. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  61. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  62. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  63. def write(oprot: TProtocol): Unit
    Definition Classes
    Aggregation → TSerializable

Inherited from Cloneable

Inherited from TBase[Aggregation, _Fields]

Inherited from Serializable

Inherited from TSerializable

Inherited from Comparable[Aggregation]

Inherited from AnyRef

Inherited from Any

Ungrouped