Type Members

1.  class Cast extends Expression with Serializable

   Represents a cast expression in the public logical expression API.

   Represents a cast expression in the public logical expression API.

   Annotations

   @Evolving()

   Since

   3.3.0

2.  trait Expression extends AnyRef

   Base class of the public logical expression API.

   Base class of the public logical expression API.

   Annotations

   @Evolving()

   Since

   3.0.0

3.  class Expressions extends AnyRef

   Helper methods to create logical transforms to pass into Spark.

   Helper methods to create logical transforms to pass into Spark.

   Annotations

   @Evolving()

   Since

   3.0.0

4.  class GeneralScalarExpression extends Expression with Serializable

   The general representation of SQL scalar expressions, which contains the upper-cased expression name and all the children expressions.

   The general representation of SQL scalar expressions, which contains the upper-cased expression name and all the children expressions. Please also see Predicate for the supported predicate expressions.

   The currently supported SQL scalar expressions:

   • Name: +
   • SQL semantic: expr1 + expr2
   • Since version: 3.3.0
   • Name: -
   • SQL semantic: expr1 - expr2 or - expr
   • Since version: 3.3.0
   • Name: *
   • SQL semantic: expr1 * expr2
   • Since version: 3.3.0
   • Name: /
   • SQL semantic: expr1 / expr2
   • Since version: 3.3.0
   • Name: %
   • SQL semantic: expr1 % expr2
   • Since version: 3.3.0
   • Name: &
   • SQL semantic: expr1 & expr2
   • Since version: 3.3.0
   • Name: |
   • SQL semantic: expr1 | expr2
   • Since version: 3.3.0
   • Name: ^
   • SQL semantic: expr1 ^ expr2
   • Since version: 3.3.0
   • Name: ~
   • SQL semantic: ~ expr
   • Since version: 3.3.0
   • Name: CASE_WHEN
   • SQL semantic: CASE WHEN expr1 THEN expr2 [WHEN expr3 THEN expr4]* [ELSE expr5] END
   • Since version: 3.3.0
   • Name: ABS
   • SQL semantic: ABS(expr)
   • Since version: 3.3.0
   • Name: COALESCE
   • SQL semantic: COALESCE(expr1, expr2)
   • Since version: 3.3.0
   • Name: LN
   • SQL semantic: LN(expr)
   • Since version: 3.3.0
   • Name: EXP
   • SQL semantic: EXP(expr)
   • Since version: 3.3.0
   • Name: POWER
   • SQL semantic: POWER(expr, number)
   • Since version: 3.3.0
   • Name: SQRT
   • SQL semantic: SQRT(expr)
   • Since version: 3.3.0
   • Name: FLOOR
   • SQL semantic: FLOOR(expr)
   • Since version: 3.3.0
   • Name: CEIL
   • SQL semantic: CEIL(expr)
   • Since version: 3.3.0
   • Name: WIDTH_BUCKET
   • SQL semantic: WIDTH_BUCKET(expr)
   • Since version: 3.3.0

   Note: SQL semantic conforms ANSI standard, so some expressions are not supported when ANSI off, including: add, subtract, multiply, divide, remainder, pmod.

   Annotations

   @Evolving()

   Since

   3.3.0

5.  trait Literal[T] extends Expression

   Represents a constant literal value in the public expression API.

   Represents a constant literal value in the public expression API.

   The JVM type of the value held by a literal must be the type used by Spark's InternalRow API for the literal's SQL data type.

   Annotations

   @Evolving()

   Since

   3.0.0

6.  trait NamedReference extends Expression

   Represents a field or column reference in the public logical expression API.

   Represents a field or column reference in the public logical expression API.

   Annotations

   @Evolving()

   Since

   3.0.0

7.  sealed abstract final class NullOrdering extends Enum[NullOrdering]

   A null order used in sorting expressions.

   A null order used in sorting expressions.

   Annotations

   @Experimental()

   Since

   3.2.0

8.  sealed abstract final class SortDirection extends Enum[SortDirection]

   A sort direction used in sorting expressions.

   A sort direction used in sorting expressions.

   Each direction has a default null ordering that is implied if no null ordering is specified explicitly.

   Annotations

   @Experimental()

   Since

   3.2.0

9.  trait SortOrder extends Expression

   Represents a sort order in the public expression API.

   Represents a sort order in the public expression API.

   Annotations

   @Experimental()

   Since

   3.2.0

10.  trait Transform extends Expression

    Represents a transform function in the public logical expression API.

    Represents a transform function in the public logical expression API.

    For example, the transform date(ts) is used to derive a date value from a timestamp column. The transform name is "date" and its argument is a reference to the "ts" column.

    Annotations

    @Evolving()

    Since

    3.0.0