Packages

c

org.apache.spark.sql.connector.expressions

GeneralScalarExpression

class GeneralScalarExpression extends ExpressionWithToString

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: GREATEST
  • SQL semantic: GREATEST(expr, ...)
  • Since version: 3.4.0
  • Name: LEAST
  • SQL semantic: LEAST(expr, ...)
  • Since version: 3.4.0
  • Name: RAND
  • SQL semantic: RAND([seed])
  • Since version: 3.4.0
  • Name: LOG
  • SQL semantic: LOG(base, expr)
  • Since version: 3.4.0
  • Name: LOG10
  • SQL semantic: LOG10(expr)
  • Since version: 3.4.0
  • Name: LOG2
  • SQL semantic: LOG2(expr)
  • Since version: 3.4.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: ROUND
  • SQL semantic: ROUND(expr, [scale])
  • Since version: 3.4.0
  • Name: SIN
  • SQL semantic: SIN(expr)
  • Since version: 3.4.0
  • Name: SINH
  • SQL semantic: SINH(expr)
  • Since version: 3.4.0
  • Name: COS
  • SQL semantic: COS(expr)
  • Since version: 3.4.0
  • Name: COSH
  • SQL semantic: COSH(expr)
  • Since version: 3.4.0
  • Name: TAN
  • SQL semantic: TAN(expr)
  • Since version: 3.4.0
  • Name: TANH
  • SQL semantic: TANH(expr)
  • Since version: 3.4.0
  • Name: COT
  • SQL semantic: COT(expr)
  • Since version: 3.4.0
  • Name: ASIN
  • SQL semantic: ASIN(expr)
  • Since version: 3.4.0
  • Name: ASINH
  • SQL semantic: ASINH(expr)
  • Since version: 3.4.0
  • Name: ACOS
  • SQL semantic: ACOS(expr)
  • Since version: 3.4.0
  • Name: ACOSH
  • SQL semantic: ACOSH(expr)
  • Since version: 3.4.0
  • Name: ATAN
  • SQL semantic: ATAN(expr)
  • Since version: 3.4.0
  • Name: ATANH
  • SQL semantic: ATANH(expr)
  • Since version: 3.4.0
  • Name: ATAN2
  • SQL semantic: ATAN2(exprY, exprX)
  • Since version: 3.4.0
  • Name: CBRT
  • SQL semantic: CBRT(expr)
  • Since version: 3.4.0
  • Name: DEGREES
  • SQL semantic: DEGREES(expr)
  • Since version: 3.4.0
  • Name: RADIANS
  • SQL semantic: RADIANS(expr)
  • Since version: 3.4.0
  • Name: SIGN
  • SQL semantic: SIGN(expr)
  • Since version: 3.4.0
  • Name: WIDTH_BUCKET
  • SQL semantic: WIDTH_BUCKET(expr)
  • Since version: 3.3.0
  • Name: SUBSTRING
  • SQL semantic: SUBSTRING(str, pos[, len])
  • Since version: 3.4.0
  • Name: UPPER
  • SQL semantic: UPPER(expr)
  • Since version: 3.4.0
  • Name: LOWER
  • SQL semantic: LOWER(expr)
  • Since version: 3.4.0
  • Name: TRANSLATE
  • SQL semantic: TRANSLATE(input, from, to)
  • Since version: 3.4.0
  • Name: TRIM
  • SQL semantic: TRIM(src, trim)
  • Since version: 3.4.0
  • Name: LTRIM
  • SQL semantic: LTRIM(src, trim)
  • Since version: 3.4.0
  • Name: RTRIM
  • SQL semantic: RTRIM(src, trim)
  • Since version: 3.4.0
  • Name: BIT_LENGTH
  • SQL semantic: BIT_LENGTH(src)
  • Since version: 3.4.0
  • Name: CHAR_LENGTH
  • SQL semantic: CHAR_LENGTH(src)
  • Since version: 3.4.0
  • Name: CONCAT
  • SQL semantic: CONCAT(col1, col2, ..., colN)
  • Since version: 3.4.0
  • Name: OVERLAY
  • SQL semantic: OVERLAY(string, replace, position[, length])
  • Since version: 3.4.0
  • Name: DATE_ADD
  • SQL semantic: DATE_ADD(start_date, num_days)
  • Since version: 3.4.0
  • Name: DATE_DIFF
  • SQL semantic: DATE_DIFF(end_date, start_date)
  • Since version: 3.4.0
  • Name: TRUNC
  • SQL semantic: TRUNC(date, format)
  • Since version: 3.4.0
  • Name: AES_ENCRYPT
  • SQL semantic: AES_ENCRYPT(expr, key[, mode[, padding]])
  • Since version: 3.4.0
  • Name: AES_DECRYPT
  • SQL semantic: AES_DECRYPT(expr, key[, mode[, padding]])
  • Since version: 3.4.0
  • Name: SHA1
  • SQL semantic: SHA1(expr)
  • Since version: 3.4.0
  • Name: SHA2
  • SQL semantic: SHA2(expr, bitLength)
  • Since version: 3.4.0
  • Name: MD5
  • SQL semantic: MD5(expr)
  • Since version: 3.4.0
  • Name: CRC32
  • SQL semantic: CRC32(expr)
  • Since version: 3.4.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()
Source
GeneralScalarExpression.java
Since

3.3.0

Linear Supertypes
ExpressionWithToString, Serializable, Expression, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GeneralScalarExpression
  2. ExpressionWithToString
  3. Serializable
  4. Expression
  5. AnyRef
  6. 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. 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
    GeneralScalarExpressionExpression
    Annotations
    @Override()
  2. 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
  3. def equals(o: AnyRef): Boolean
    Definition Classes
    GeneralScalarExpression → AnyRef → Any
    Annotations
    @Override()
  4. def hashCode(): Int
    Definition Classes
    GeneralScalarExpression → AnyRef → Any
    Annotations
    @Override()
  5. def name(): String
  6. 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
  7. def toString(): String
    Definition Classes
    ExpressionWithToString → AnyRef → Any