Packages

abstract class PartitionPredicate extends Predicate

Represents a partition predicate that can be evaluated using Table#partitioning().

Connectors are expected to leverage partition predicates for pruning whenever they have partition metadata to evaluate them. Use #eval(InternalRow) to evaluate this predicate against a single partition's keys.

Annotations
@Evolving()
Source
PartitionPredicate.java
Since

4.2.0

Linear Supertypes
Predicate, GeneralScalarExpression, ExpressionWithToString, Serializable, Expression, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PartitionPredicate
  2. Predicate
  3. GeneralScalarExpression
  4. ExpressionWithToString
  5. Serializable
  6. Expression
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new PartitionPredicate()
    Attributes
    protected[filter]

Abstract Value Members

  1. abstract def eval(partitionKey: InternalRow): Boolean

    Evaluates this predicate against a single partition's keys.

    Evaluates this predicate against a single partition's keys.

    The caller must pass the full partition key: one value per partition transform in Table#partitioning(), in order. A key for only a subset of referenced fields is not supported.

    partitionKey

    the full partition key for one partition, ordered according to Table#partitioning().

    returns

    true if the partition represented by these keys satisfies this predicate.

Concrete 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
    GeneralScalarExpressionExpression
    Annotations
    @Override()
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @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. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  11. def hashCode(): Int
    Definition Classes
    GeneralScalarExpression → AnyRef → Any
    Annotations
    @Override()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. def name(): String
    Definition Classes
    GeneralScalarExpression
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  17. 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
  18. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  19. def toString(): String
    Definition Classes
    ExpressionWithToString → AnyRef → Any
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  22. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from Predicate

Inherited from ExpressionWithToString

Inherited from Serializable

Inherited from Expression

Inherited from AnyRef

Inherited from Any

Ungrouped