io.delta.kernel.expressions

Class Predicate

Object

io.delta.kernel.expressions.ScalarExpression

io.delta.kernel.expressions.Predicate

All Implemented Interfaces:

Expression

Direct Known Subclasses:

AlwaysFalse, AlwaysTrue, And, Or

@Evolving
public class Predicate
extends ScalarExpression

Defines predicate scalar expression which is an extension of ScalarExpression that evaluates to true, false, or null for each input row.

Currently, implementations of ExpressionHandler requires support for at least the following scalar expressions.

1. Name: =
   • SQL semantic: expr1 = expr2
   • Since version: 3.0.0
2. Name: <
   • SQL semantic: expr1 < expr2
   • Since version: 3.0.0
3. Name: <=
   • SQL semantic: expr1 <= expr2
   • Since version: 3.0.0
4. Name: >
   • SQL semantic: expr1 > expr2
   • Since version: 3.0.0
5. Name: >=
   • SQL semantic: expr1 >= expr2
   • Since version: 3.0.0
6. Name: ALWAYS_TRUE
   • SQL semantic: Constant expression whose value is `true`
   • Since version: 3.0.0
7. Name: ALWAYS_FALSE
   • SQL semantic: Constant expression whose value is `false`
   • Since version: 3.0.0
8. Name: AND
   • SQL semantic: expr1 AND expr2
   • Since version: 3.0.0
9. Name: OR
   • SQL semantic: expr1 OR expr2
   • Since version: 3.0.0
10. Name: NOT
    • SQL semantic: NOT expr
    • Since version: 3.1.0
11. Name: IS_NOT_NULL
    • SQL semantic: expr IS NOT NULL
    • Since version: 3.1.0
12. Name: IS_NULL
    • SQL semantic: expr IS NULL
    • Since version: 3.2.0
13. Name: LIKE
    • SQL semantic: expr LIKE expr
    • Since version: 3.3.0
14. Name: IS NOT DISTINCT FROM
    • SQL semantic: expr1 IS NOT DISTINCT FROM expr2
    • Since version: 3.3.0

Since:

3.0.0

Constructor Summary

Constructors

Constructor and Description
Predicate(String name, Expression child) Constructor for a unary Predicate expression
Predicate(String name, Expression left, Expression right) Constructor for a binary Predicate expression
Predicate(String name, java.util.List<Expression> children)

Method Summary

Modifier and Type	Method and Description
String	toString()

Methods inherited from class io.delta.kernel.expressions.ScalarExpression

getChildren, getName

Methods inherited from class Object

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

Constructor Detail

Predicate

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

Predicate

public Predicate(String name,
                 Expression child)

Constructor for a unary Predicate expression

Predicate

public Predicate(String name,
                 Expression left,
                 Expression right)

Constructor for a binary Predicate expression

Method Detail

toString

public String toString()

Overrides:

toString in class ScalarExpression