Type Members

1.  case class AlwaysFalse() extends Filter with Product with Serializable

   A filter that always evaluates to false.

   A filter that always evaluates to false.

   Annotations

   @Evolving()

   Since

   3.0.0

2.  case class AlwaysTrue() extends Filter with Product with Serializable

   A filter that always evaluates to true.

   A filter that always evaluates to true.

   Annotations

   @Evolving()

   Since

   3.0.0

3.  case class And(left: Filter, right: Filter) extends Filter with Product with Serializable

   A filter that evaluates to true iff both left or right evaluate to true.

   A filter that evaluates to true iff both left or right evaluate to true.

   Annotations

   @Stable()

   Since

   1.3.0

4.  case class EqualNullSafe(attribute: String, value: Any) extends Filter with Product with Serializable

   Performs equality comparison, similar to EqualTo.

   Performs equality comparison, similar to EqualTo. However, this differs from EqualTo in that it returns true (rather than NULL) if both inputs are NULL, and false (rather than NULL) if one of the input is NULL and the other is not NULL.

   attribute

   of the column to be evaluated; dots are used as separators for nested columns. If any part of the names contains dots, it is quoted to avoid confusion.

   Annotations

   @Stable()

   Since

   1.5.0

5.  case class EqualTo(attribute: String, value: Any) extends Filter with Product with Serializable

   A filter that evaluates to true iff the column evaluates to a value equal to value.

   A filter that evaluates to true iff the column evaluates to a value equal to value.

   attribute

   of the column to be evaluated; dots are used as separators for nested columns. If any part of the names contains dots, it is quoted to avoid confusion.

   Annotations

   @Stable()

   Since

   1.3.0

6.  sealed abstract class Filter extends AnyRef

   A filter predicate for data sources.

   A filter predicate for data sources. Mapping between Spark SQL types and filter value types follow the convention for return type of org.apache.spark.sql.Row#get(int).

   Annotations

   @Stable()

   Since

   1.3.0

7.  case class GreaterThan(attribute: String, value: Any) extends Filter with Product with Serializable

   A filter that evaluates to true iff the attribute evaluates to a value greater than value.

   A filter that evaluates to true iff the attribute evaluates to a value greater than value.

   attribute

   of the column to be evaluated; dots are used as separators for nested columns. If any part of the names contains dots, it is quoted to avoid confusion.

   Annotations

   @Stable()

   Since

   1.3.0

8.  case class GreaterThanOrEqual(attribute: String, value: Any) extends Filter with Product with Serializable

   A filter that evaluates to true iff the attribute evaluates to a value greater than or equal to value.

   A filter that evaluates to true iff the attribute evaluates to a value greater than or equal to value.

   attribute

   of the column to be evaluated; dots are used as separators for nested columns. If any part of the names contains dots, it is quoted to avoid confusion.

   Annotations

   @Stable()

   Since

   1.3.0

9.  case class In(attribute: String, values: Array[Any]) extends Filter with Product with Serializable

   A filter that evaluates to true iff the attribute evaluates to one of the values in the array.

   A filter that evaluates to true iff the attribute evaluates to one of the values in the array.

   attribute

   of the column to be evaluated; dots are used as separators for nested columns. If any part of the names contains dots, it is quoted to avoid confusion.

   Annotations

   @Stable()

   Since

   1.3.0

10.  case class IsNotNull(attribute: String) extends Filter with Product with Serializable

    A filter that evaluates to true iff the attribute evaluates to a non-null value.

    A filter that evaluates to true iff the attribute evaluates to a non-null value.

    attribute

    of the column to be evaluated; dots are used as separators for nested columns. If any part of the names contains dots, it is quoted to avoid confusion.

    Annotations

    @Stable()

    Since

    1.3.0

11.  case class IsNull(attribute: String) extends Filter with Product with Serializable

    A filter that evaluates to true iff the attribute evaluates to null.

    A filter that evaluates to true iff the attribute evaluates to null.

    attribute

    of the column to be evaluated; dots are used as separators for nested columns. If any part of the names contains dots, it is quoted to avoid confusion.

    Annotations

    @Stable()

    Since

    1.3.0

12.  case class LessThan(attribute: String, value: Any) extends Filter with Product with Serializable

    A filter that evaluates to true iff the attribute evaluates to a value less than value.

    A filter that evaluates to true iff the attribute evaluates to a value less than value.

    attribute

    of the column to be evaluated; dots are used as separators for nested columns. If any part of the names contains dots, it is quoted to avoid confusion.

    Annotations

    @Stable()

    Since

    1.3.0

13.  case class LessThanOrEqual(attribute: String, value: Any) extends Filter with Product with Serializable

    A filter that evaluates to true iff the attribute evaluates to a value less than or equal to value.

    A filter that evaluates to true iff the attribute evaluates to a value less than or equal to value.

    attribute

    of the column to be evaluated; dots are used as separators for nested columns. If any part of the names contains dots, it is quoted to avoid confusion.

    Annotations

    @Stable()

    Since

    1.3.0

14.  case class Not(child: Filter) extends Filter with Product with Serializable

    A filter that evaluates to true iff child is evaluated to false.

    A filter that evaluates to true iff child is evaluated to false.

    Annotations

    @Stable()

    Since

    1.3.0

15.  case class Or(left: Filter, right: Filter) extends Filter with Product with Serializable

    A filter that evaluates to true iff at least one of left or right evaluates to true.

    A filter that evaluates to true iff at least one of left or right evaluates to true.

    Annotations

    @Stable()

    Since

    1.3.0

16.  case class StringContains(attribute: String, value: String) extends Filter with Product with Serializable

    A filter that evaluates to true iff the attribute evaluates to a string that contains the string value.

    A filter that evaluates to true iff the attribute evaluates to a string that contains the string value.

    attribute

    of the column to be evaluated; dots are used as separators for nested columns. If any part of the names contains dots, it is quoted to avoid confusion.

    Annotations

    @Stable()

    Since

    1.3.1

17.  case class StringEndsWith(attribute: String, value: String) extends Filter with Product with Serializable

    A filter that evaluates to true iff the attribute evaluates to a string that ends with value.

    A filter that evaluates to true iff the attribute evaluates to a string that ends with value.

    attribute

    of the column to be evaluated; dots are used as separators for nested columns. If any part of the names contains dots, it is quoted to avoid confusion.

    Annotations

    @Stable()

    Since

    1.3.1

18.  case class StringStartsWith(attribute: String, value: String) extends Filter with Product with Serializable

    A filter that evaluates to true iff the attribute evaluates to a string that starts with value.

    A filter that evaluates to true iff the attribute evaluates to a string that starts with value.

    attribute

    of the column to be evaluated; dots are used as separators for nested columns. If any part of the names contains dots, it is quoted to avoid confusion.

    Annotations

    @Stable()

    Since

    1.3.1