Packages

trait SupportsDelete extends SupportsDeleteV2

A mix-in interface for Table delete support. Data sources can implement this interface to provide the ability to delete data from tables that matches filter expressions.

Annotations
@Evolving()
Source
SupportsDelete.java
Since

3.0.0

Linear Supertypes
SupportsDeleteV2, TruncatableTable, Table, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SupportsDelete
  2. SupportsDeleteV2
  3. TruncatableTable
  4. Table
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def capabilities(): Set[TableCapability]

    Returns the set of capabilities for this table.

    Returns the set of capabilities for this table.

    Definition Classes
    Table
  2. abstract def deleteWhere(filters: Array[Filter]): Unit

    Delete data from a data source table that matches filter expressions.

    Delete data from a data source table that matches filter expressions. Note that this method will be invoked only if #canDeleteWhere(Filter[]) returns true.

    Rows are deleted from the data source iff all of the filter expressions match. That is, the expressions must be interpreted as a set of filters that are ANDed together.

    Implementations may reject a delete operation if the delete isn't possible without significant effort. For example, partitioned data sources may reject deletes that do not filter by partition columns because the filter may require rewriting files without deleted records. To reject a delete implementations should throw IllegalArgumentException with a clear error message that identifies which expression was rejected.

    filters

    filter expressions, used to select rows to delete when all expressions match

    Exceptions thrown

    IllegalArgumentException If the delete is rejected due to required effort

  3. abstract def name(): String

    A name to identify this table.

    A name to identify this table. Implementations should provide a meaningful name, like the database and table name from catalog, or the location of files for this table.

    Definition Classes
    Table

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 canDeleteWhere(predicates: Array[Predicate]): Boolean

    Checks whether it is possible to delete data from a data source table that matches filter expressions.

    Checks whether it is possible to delete data from a data source table that matches filter expressions.

    Rows should be deleted from the data source iff all of the filter expressions match. That is, the expressions must be interpreted as a set of filters that are ANDed together.

    Spark will call this method at planning time to check whether #deleteWhere(Predicate[]) would reject the delete operation because it requires significant effort. If this method returns false, Spark will not call #deleteWhere(Predicate[]) and will try to rewrite the delete operation and produce row-level changes if the data source table supports deleting individual records.

    predicates

    V2 filter expressions, used to select rows to delete when all expressions match

    returns

    true if the delete operation can be performed

    Definition Classes
    SupportsDelete → SupportsDeleteV2
    Since

    3.4.0

  6. def canDeleteWhere(filters: Array[Filter]): Boolean

    Checks whether it is possible to delete data from a data source table that matches filter expressions.

    Checks whether it is possible to delete data from a data source table that matches filter expressions.

    Rows should be deleted from the data source iff all of the filter expressions match. That is, the expressions must be interpreted as a set of filters that are ANDed together.

    Spark will call this method at planning time to check whether #deleteWhere(Filter[]) would reject the delete operation because it requires significant effort. If this method returns false, Spark will not call #deleteWhere(Filter[]) and will try to rewrite the delete operation and produce row-level changes if the data source table supports deleting individual records.

    filters

    filter expressions, used to select rows to delete when all expressions match

    returns

    true if the delete operation can be performed

    Since

    3.1.0

  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  8. def columns(): Array[Column]

    Returns the columns of this table.

    Returns the columns of this table. If the table is not readable and doesn't have a schema, an empty array can be returned here.

    Definition Classes
    Table
  9. def constraints(): Array[Constraint]

    Returns the constraints for this table.

    Returns the constraints for this table.

    Definition Classes
    Table
  10. def deleteWhere(predicates: Array[Predicate]): Unit

    Delete data from a data source table that matches filter expressions.

    Delete data from a data source table that matches filter expressions. Note that this method will be invoked only if #canDeleteWhere(Predicate[]) returns true.

    Rows are deleted from the data source iff all of the filter expressions match. That is, the expressions must be interpreted as a set of filters that are ANDed together.

    Implementations may reject a delete operation if the delete isn't possible without significant effort. For example, partitioned data sources may reject deletes that do not filter by partition columns because the filter may require rewriting files without deleted records. To reject a delete implementations should throw IllegalArgumentException with a clear error message that identifies which expression was rejected.

    predicates

    predicate expressions, used to select rows to delete when all expressions match

    Definition Classes
    SupportsDelete → SupportsDeleteV2
    Exceptions thrown

    IllegalArgumentException If the delete is rejected due to required effort

  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  15. def id(): String

    An ID of the table that can be used to reliably check if two table objects refer to the same metastore entity.

    An ID of the table that can be used to reliably check if two table objects refer to the same metastore entity. If a table is dropped and recreated again with the same name, the new table ID must be different. This method must return null if connectors don't support the notion of table ID.

    Definition Classes
    Table
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  20. def partitioning(): Array[Transform]

    Returns the physical partitioning of this table.

    Returns the physical partitioning of this table.

    Definition Classes
    Table
  21. def properties(): Map[String, String]

    Returns the string map of table properties.

    Returns the string map of table properties.

    Definition Classes
    Table
  22. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  23. def toString(): String
    Definition Classes
    AnyRef → Any
  24. def truncateTable(): Boolean

    Truncate a table by removing all rows from the table atomically.

    Truncate a table by removing all rows from the table atomically.

    returns

    true if a table was truncated successfully otherwise false

    Definition Classes
    SupportsDelete → SupportsDeleteV2 → TruncatableTable
    Annotations
    @Override()
    Since

    3.2.0

  25. def version(): String

    Returns the version of this table if versioning is supported, null otherwise.

    Returns the version of this table if versioning is supported, null otherwise.

    This method must not trigger a refresh of the table metadata. It should return the version that corresponds to the current state of this table instance.

    Definition Classes
    Table
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  28. 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)

  2. def schema(): StructType

    Returns the schema of this table.

    Returns the schema of this table. If the table is not readable and doesn't have a schema, an empty schema can be returned here.

    Definition Classes
    Table
    Annotations
    @Deprecated
    Deprecated

    (Since version 3.4.0)

Inherited from SupportsDeleteV2

Inherited from TruncatableTable

Inherited from Table

Inherited from AnyRef

Inherited from Any

Ungrouped