case class RemoveFile(path: String, deletionTimestamp: Option[Long], dataChange: Boolean = true, extendedFileMetadata: Option[Boolean] = None, partitionValues: Map[String, String] = null, size: Option[Long] = None, tags: Map[String, String] = null, deletionVector: DeletionVectorDescriptor = null, baseRowId: Option[Long] = None, defaultRowCommitVersion: Option[Long] = None, stats: String = null) extends FileAction with HasNumRecords with Product with Serializable

Logical removal of a given file from the reservoir. Acts as a tombstone before a file is deleted permanently.

Note that for protocol compatibility reasons, the fields partitionValues, size, and tags are only present when the extendedFileMetadata flag is true. New writers should generally be setting this flag, but old writers (and FSCK) won't, so readers must check this flag before attempting to consume those values.

Since old tables would not have extendedFileMetadata and size field, we should make them nullable by setting their type Option.

path is URL-encoded.

Linear Supertypes
Serializable, Product, Equals, HasNumRecords, FileAction, Action, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RemoveFile
  2. Serializable
  3. Product
  4. Equals
  5. HasNumRecords
  6. FileAction
  7. Action
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new RemoveFile(path: String, deletionTimestamp: Option[Long], dataChange: Boolean = true, extendedFileMetadata: Option[Boolean] = None, partitionValues: Map[String, String] = null, size: Option[Long] = None, tags: Map[String, String] = null, deletionVector: DeletionVectorDescriptor = null, baseRowId: Option[Long] = None, defaultRowCommitVersion: Option[Long] = None, stats: String = null)

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. val baseRowId: Option[Long]
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  7. def copyWithTag(tag: String, value: String): RemoveFile

    Create a copy with the new tag.

    Create a copy with the new tag. extendedFileMetadata is copied unchanged.

  8. def copyWithoutTag(tag: String): RemoveFile

    Create a copy without the tag.

  9. val dataChange: Boolean
    Definition Classes
    RemoveFile → FileAction
  10. val defaultRowCommitVersion: Option[Long]
  11. val delTimestamp: Long
  12. def deletedToPhysicalRecordsRatio: Option[Double]

    Returns the ratio of number of deleted records to the total number of records.

    Returns the ratio of number of deleted records to the total number of records.

    Definition Classes
    HasNumRecords
    Annotations
    @JsonIgnore()
  13. val deletionTimestamp: Option[Long]
  14. val deletionVector: DeletionVectorDescriptor
    Definition Classes
    RemoveFile → FileAction
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def estLogicalFileSize: Option[Long]

    Returns the estimated size of the logical records in the file.

    Returns the estimated size of the logical records in the file.

    Definition Classes
    HasNumRecords
    Annotations
    @JsonIgnore()
  17. val extendedFileMetadata: Option[Boolean]
  18. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  19. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  20. def getDeletionVectorUniqueId: Option[String]

    Return the unique id of the deletion vector, if present, or None if there's no DV.

    Return the unique id of the deletion vector, if present, or None if there's no DV.

    The unique id differentiates DVs, even if there are multiple in the same file or the DV is stored inline.

    Annotations
    @JsonIgnore()
  21. def getFileSize: Long
    Definition Classes
    RemoveFile → FileAction
    Annotations
    @JsonIgnore()
  22. def getTag(tagName: String): Option[String]

    Return tag value if tags is not null and the tag present.

    Return tag value if tags is not null and the tag present.

    Definition Classes
    FileAction
    Annotations
    @JsonIgnore()
  23. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  24. def json: String
    Definition Classes
    Action
  25. def logicalToPhysicalRecordsRatio: Option[Double]

    Returns the ratio of the logical number of records to the total number of records.

    Returns the ratio of the logical number of records to the total number of records.

    Definition Classes
    HasNumRecords
    Annotations
    @JsonIgnore()
  26. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  28. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  29. def numDeletedRecords: Long

    Returns the number of records marked as deleted.

    Returns the number of records marked as deleted.

    Definition Classes
    HasNumRecords
    Annotations
    @JsonIgnore()
  30. lazy val numLogicalRecords: Option[Long]

    Returns the number of logical records, which do not include those marked as deleted.

    Returns the number of logical records, which do not include those marked as deleted.

    Definition Classes
    HasNumRecords
    Annotations
    @JsonIgnore() @transient()
  31. def numPhysicalRecords: Option[Long]

    Returns the total number of records, including those marked as deleted.

    Returns the total number of records, including those marked as deleted.

    Definition Classes
    HasNumRecords
    Annotations
    @JsonIgnore()
  32. lazy val parsedStatsFields: Option[ParsedStatsFields]
    Attributes
    protected
    Definition Classes
    HasNumRecords
    Annotations
    @JsonIgnore() @transient()
  33. val partitionValues: Map[String, String]
    Definition Classes
    RemoveFile → FileAction
  34. val path: String
    Definition Classes
    RemoveFile → FileAction
  35. lazy val pathAsUri: URI
    Definition Classes
    FileAction
    Annotations
    @JsonIgnore()
  36. def productElementNames: Iterator[String]
    Definition Classes
    Product
  37. val size: Option[Long]
  38. val stats: String
    Definition Classes
    RemoveFile → FileAction
  39. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  40. val tags: Map[String, String]
    Definition Classes
    RemoveFile → FileAction
  41. lazy val tightBounds: Option[Boolean]

    Returns whether the statistics are tight or wide.

    Returns whether the statistics are tight or wide.

    Definition Classes
    HasNumRecords
    Annotations
    @JsonIgnore() @transient()
  42. def toPath: Path
    Definition Classes
    FileAction
  43. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  44. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  45. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  46. def wrap: SingleAction
    Definition Classes
    RemoveFile → Action

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from HasNumRecords

Inherited from FileAction

Inherited from Action

Inherited from AnyRef

Inherited from Any

Ungrouped