io.delta.kernel.expressions

Class ScalarExpression

Object

io.delta.kernel.expressions.ScalarExpression

All Implemented Interfaces:

Expression

Direct Known Subclasses:

Predicate

@Evolving
public class ScalarExpression
extends Object
implements Expression

Scalar SQL expressions which take zero or more inputs and for each input row generate one output value. A subclass of these expressions are of type Predicate whose result type is `boolean`. See Predicate for predicate type scalar expressions. Supported non-predicate type scalar expressions are listed below.

1. Name: element_at
   • Semantic: element_at(map, key). Return the value of given key from the map type input. Returns null if the given key is not in the map Ex: `element_at(map(1, 'a', 2, 'b'), 2)` returns 'b'
   • Since version: 3.0.0
2. Name: COALESCE
   • Semantic: COALESCE(expr1, ..., exprN) Return the first non-null argument. If all arguments are null returns null
   • Since version: 3.1.0
3. Name: TIMEADD
   • Semantic: TIMEADD(colExpr, milliseconds). Add the specified number of milliseconds to the timestamp represented by colExpr. The adjustment does not alter the original value but returns a new timestamp increased by the given milliseconds. Ex: `TIMEADD(timestampColumn, 1000)` returns a timestamp 1 second later.
   • Since version: 3.3.0

Since:

3.0.0

Constructor Summary

Constructors

Constructor and Description
ScalarExpression(String name, java.util.List<Expression> children)

Method Summary

Modifier and Type	Method and Description
java.util.List<Expression>	getChildren()
String	getName()
String	toString()

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ScalarExpression

public ScalarExpression(String name,
                        java.util.List<Expression> children)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getName

public String getName()

getChildren

public java.util.List<Expression> getChildren()

Specified by:

getChildren in interface Expression

Returns:

a list of expressions that are input to this expression.