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, Serializable, Product, Equals, HasNumRecords, FileAction, Action, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RemoveFile
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. HasNumRecords
  7. FileAction
  8. Action
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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. def absolutePath(deltaLog: DeltaLog): Path

    Returns the absolute Path for this file action (not URL-encoded).

    Returns the absolute Path for this file action (not URL-encoded).

    Definition Classes
    FileAction
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. val baseRowId: Option[Long]
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  8. 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.

  9. def copyWithoutTag(tag: String): RemoveFile

    Create a copy without the tag.

  10. val dataChange: Boolean
    Definition Classes
    RemoveFile → FileAction
  11. val defaultRowCommitVersion: Option[Long]
  12. val delTimestamp: Long
  13. 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()
  14. val deletionTimestamp: Option[Long]
  15. val deletionVector: DeletionVectorDescriptor
    Definition Classes
    RemoveFile → FileAction
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. 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()
  18. val extendedFileMetadata: Option[Boolean]
  19. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  20. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  21. 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()
  22. def getFileSize: Long
    Definition Classes
    RemoveFile → FileAction
    Annotations
    @JsonIgnore()
  23. 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()
  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. def json: String
    Definition Classes
    Action
  26. 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()
  27. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  29. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  30. def numDeletedRecords: Long

    Returns the number of records marked as deleted.

    Returns the number of records marked as deleted.

    Definition Classes
    HasNumRecords
    Annotations
    @JsonIgnore()
  31. 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()
  32. 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()
  33. lazy val parsedStatsFields: Option[ParsedStatsFields]
    Attributes
    protected
    Definition Classes
    HasNumRecords
    Annotations
    @JsonIgnore() @transient()
  34. val partitionValues: Map[String, String]
    Definition Classes
    RemoveFile → FileAction
  35. val path: String
    Definition Classes
    RemoveFile → FileAction
  36. lazy val pathAsUri: URI
    Definition Classes
    FileAction
    Annotations
    @JsonIgnore()
  37. val size: Option[Long]
  38. def sparkPath: SparkPath

    Returns the SparkPath for this file action.

    Returns the SparkPath for this file action.

    Definition Classes
    FileAction
  39. val stats: String
    Definition Classes
    RemoveFile → FileAction
  40. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  41. val tags: Map[String, String]
    Definition Classes
    RemoveFile → FileAction
  42. def tagsOrEmpty: Map[String, String]

    Returns tags or an empty Map if null

    Returns tags or an empty Map if null

    Definition Classes
    FileAction
    Annotations
    @JsonIgnore()
  43. 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()
  44. def toPath: Path

    Returns the Path for this file action (not URL-encoded).

    Returns the Path for this file action (not URL-encoded).

    Definition Classes
    FileAction
  45. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  46. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  47. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  48. def wrap: SingleAction
    Definition Classes
    RemoveFile → Action

Inherited from Serializable

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