org.apache.spark.sql.connector.expressions

Class GeneralScalarExpression

Object

org.apache.spark.sql.connector.expressions.GeneralScalarExpression

All Implemented Interfaces:

java.io.Serializable, Expression

Direct Known Subclasses:

Predicate

@Evolving
public class GeneralScalarExpression
extends Object
implements Expression, java.io.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:

1. Name: +
   • SQL semantic: expr1 + expr2
   • Since version: 3.3.0
2. Name: -
   • SQL semantic: expr1 - expr2 or - expr
   • Since version: 3.3.0
3. Name: *
   • SQL semantic: expr1 * expr2
   • Since version: 3.3.0
4. Name: /
   • SQL semantic: expr1 / expr2
   • Since version: 3.3.0
5. Name: %
   • SQL semantic: expr1 % expr2
   • Since version: 3.3.0
6. Name: &
   • SQL semantic: expr1 & expr2
   • Since version: 3.3.0
7. Name: |
   • SQL semantic: expr1 | expr2
   • Since version: 3.3.0
8. Name: ^
   • SQL semantic: expr1 ^ expr2
   • Since version: 3.3.0
9. Name: ~
   • SQL semantic: ~ expr
   • Since version: 3.3.0
10. Name: CASE_WHEN
    • SQL semantic: CASE WHEN expr1 THEN expr2 [WHEN expr3 THEN expr4]* [ELSE expr5] END
    • Since version: 3.3.0
11. Name: ABS
    • SQL semantic: ABS(expr)
    • Since version: 3.3.0
12. Name: COALESCE
    • SQL semantic: COALESCE(expr1, expr2)
    • Since version: 3.3.0
13. Name: LN
    • SQL semantic: LN(expr)
    • Since version: 3.3.0
14. Name: EXP
    • SQL semantic: EXP(expr)
    • Since version: 3.3.0
15. Name: POWER
    • SQL semantic: POWER(expr, number)
    • Since version: 3.3.0
16. Name: SQRT
    • SQL semantic: SQRT(expr)
    • Since version: 3.3.0
17. Name: FLOOR
    • SQL semantic: FLOOR(expr)
    • Since version: 3.3.0
18. Name: CEIL
    • SQL semantic: CEIL(expr)
    • Since version: 3.3.0
19. 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.

Since:

3.3.0

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.apache.spark.sql.connector.expressions.Expression

EMPTY_EXPRESSION

Constructor Summary

Constructors

Constructor and Description
GeneralScalarExpression(String name, Expression[] children)

Method Summary

Modifier and Type	Method and Description
Expression[]	children() Returns an array of the children of this node.
boolean	equals(Object o)
int	hashCode()
String	name()
String	toString()

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.spark.sql.connector.expressions.Expression

describe, references

Constructor Detail

GeneralScalarExpression

public GeneralScalarExpression(String name,
                               Expression[] children)

Method Detail

name

public String name()

children

public Expression[] children()

Description copied from interface: Expression

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

Specified by:

children in interface Expression

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object