Packages

c

org.apache.spark.sql.connector.expressions

GeneralScalarExpression

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. 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

Linear Supertypes
Serializable, Expression, AnyRef, Any
Known Subclasses
AlwaysFalse, AlwaysTrue, And, Not, Or, Predicate
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GeneralScalarExpression
  2. Serializable
  3. Expression
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new GeneralScalarExpression(name: String, children: Array[Expression])

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def children(): Array[Expression]

    Returns an array of the children of this node.

    Returns an array of the children of this node. Children should not change.

    Definition Classes
    GeneralScalarExpression → Expression
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  7. def describe(): String

    Format the expression as a human readable SQL-like string.

    Format the expression as a human readable SQL-like string.

    Definition Classes
    Expression
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(o: AnyRef): Boolean
    Definition Classes
    GeneralScalarExpression → AnyRef → Any
    Annotations
    @Override()
  10. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. def hashCode(): Int
    Definition Classes
    GeneralScalarExpression → AnyRef → Any
    Annotations
    @Override()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. def name(): String
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. def references(): Array[NamedReference]

    List of fields or columns that are referenced by this expression.

    List of fields or columns that are referenced by this expression.

    Definition Classes
    Expression
  19. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  20. def toString(): String
    Definition Classes
    GeneralScalarExpression → AnyRef → Any
    Annotations
    @Override()
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Serializable

Inherited from Expression

Inherited from AnyRef

Inherited from Any

Ungrouped