Enum Class FunctionType

java.lang.Object
java.lang.Enum<FunctionType>
org.elasticsearch.xpack.esql.expression.function.FunctionType
All Implemented Interfaces:
Serializable, Comparable<FunctionType>, Constable

public enum FunctionType extends Enum<FunctionType>
The position the function can appear in the language.
  • Enum Constant Details

    • SCALAR

      public static final FunctionType SCALAR
      Functions that can appear anywhere. For example, LENGTH in | STATS MAX(LENGTH(string)) and | EVAL l = LENGTH(string).
    • AGGREGATE

      public static final FunctionType AGGREGATE
      Functions that can only appear in the "aggregate" position of a STATS. For example, MAX in | STATS MAX(LENGTH(string)).
    • TIME_SERIES_AGGREGATE

      public static final FunctionType TIME_SERIES_AGGREGATE
      Functions that can only appear in the aggregate" position of a STATS started with TS. For example, MAX_OVER_TIME in | STATS MAX(MAX_OVER_TIME(string)).
    • GROUPING

      public static final FunctionType GROUPING
      Functions that can only appear in the "grouping" position of a STATS. For example, CATEGORIZE in | STATS MAX(a) BY CATEGORIZE(message).
  • Method Details

    • values

      public static FunctionType[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static FunctionType valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null