object FileNames

Helper for creating file names for specific commits / checkpoints.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FileNames
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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. val COMMIT_SUBDIR: String
  5. val SIDECAR_SUBDIR: String
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. val checkpointFileRegex: Regex
  8. def checkpointFileSingular(path: Path, version: Long): Path

    Returns the path for a singular checkpoint up to the given version.

    Returns the path for a singular checkpoint up to the given version.

    In a future protocol version this path will stop being written.

  9. def checkpointFileWithParts(path: Path, version: Long, numParts: Int): Seq[Path]

    Returns the paths for all parts of the checkpoint up to the given version.

    Returns the paths for all parts of the checkpoint up to the given version.

    In a future protocol version we will write this path instead of checkpointFileSingular.

    Example of the format: 00000000000000004915.checkpoint.0000000020.0000000060.parquet is checkpoint part 20 out of 60 for the snapshot at version 4915. Zero padding is for lexicographic sorting.

  10. def checkpointVersion(file: FileStatus): Long
  11. def checkpointVersion(path: Path): Long
  12. def checksumFile(path: Path, version: Long): Path

    Returns the path to the checksum file for the given version.

  13. val checksumFileRegex: Regex
  14. def checksumVersion(file: FileStatus): Long
  15. def checksumVersion(path: Path): Long

    Returns the version for the given checksum file.

  16. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  17. def commitDirPath(logPath: Path): Path

    Returns path to the sidecar directory

  18. def compactedDeltaFile(path: Path, fromVersion: Long, toVersion: Long): Path

    Returns the path to the compacted delta file for the given version range.

  19. val compactedDeltaFileRegex: Regex
  20. def compactedDeltaVersions(file: FileStatus): (Long, Long)
  21. def compactedDeltaVersions(path: Path): (Long, Long)
  22. val deltaFileRegex: Regex
  23. def deltaVersion(file: FileStatus): Long
  24. def deltaVersion(path: Path): Long

    Returns the version for the given delta path.

  25. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  27. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  28. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  29. def getFileVersion(file: FileStatus): Long
  30. def getFileVersion(path: Path): Long

    Get the version of the checkpoint, checksum or delta file.

    Get the version of the checkpoint, checksum or delta file. Throws an error if an unexpected file type is seen. These unexpected files should be filtered out to ensure forward compatibility in cases where new file types are added, but without an explicit protocol upgrade.

  31. def getFileVersionOpt(path: Path): Option[Long]

    Get the version of the checkpoint, checksum or delta file.

    Get the version of the checkpoint, checksum or delta file. Returns None if an unexpected file type is seen.

  32. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  33. def isCheckpointFile(file: FileStatus): Boolean
  34. def isCheckpointFile(path: Path): Boolean
  35. def isChecksumFile(file: FileStatus): Boolean
  36. def isChecksumFile(path: Path): Boolean
  37. def isCompactedDeltaFile(file: FileStatus): Boolean
  38. def isCompactedDeltaFile(path: Path): Boolean
  39. def isDeltaFile(file: FileStatus): Boolean
  40. def isDeltaFile(path: Path): Boolean
  41. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  42. def isUnbackfilledDeltaFile(file: FileStatus): Boolean
  43. def isUnbackfilledDeltaFile(path: Path): Boolean
  44. def listingPrefix(path: Path, version: Long): Path

    Returns the prefix of all delta log files for the given version.

    Returns the prefix of all delta log files for the given version.

    Intended for use with listFrom to get all files from this version onwards. The returned Path will not exist as a file.

  45. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  46. def newV2CheckpointJsonFile(path: Path, version: Long): Path

    File path for a new V2 Checkpoint Json file

  47. def newV2CheckpointParquetFile(path: Path, version: Long): Path

    File path for a new V2 Checkpoint Parquet file

  48. def newV2CheckpointSidecarFile(logPath: Path, version: Long, numParts: Int, currentPart: Int): Path

    File path for a V2 Checkpoint's Sidecar file

  49. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  50. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  51. def numCheckpointParts(path: Path): Option[Int]
  52. def sampleFile(path: Path, version: Long): Path

    Returns the path for a given sample file

  53. def sidecarDirPath(logPath: Path): Path

    Returns path to the sidecar directory

  54. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  55. def toString(): String
    Definition Classes
    AnyRef → Any
  56. def unbackfilledDeltaFile(logPath: Path, version: Long, uuidString: Option[String] = None): Path

    Returns the un-backfilled uuid formatted delta (json format) path for a given version.

    Returns the un-backfilled uuid formatted delta (json format) path for a given version.

    logPath

    The root path of the delta log.

    version

    The version of the delta file.

    returns

    The path to the un-backfilled delta file: <logPath>/_commits/<version>.<uuid>.json

  57. def unsafeDeltaFile(path: Path, version: Long): Path

    Returns the delta (json format) path for a given delta file.

    Returns the delta (json format) path for a given delta file. WARNING: This API is unsafe and can resolve to incorrect paths if the table has Managed Commits. Use DeltaCommitFileProvider(snapshot).deltaFile instead to guarantee accurate paths.

  58. val uuidDeltaFileRegex: Regex
  59. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  60. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  61. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  62. object CheckpointFile
  63. object ChecksumFile
  64. object CompactedDeltaFile
  65. object DeltaFile
  66. object FileType extends Enumeration
  67. object UnbackfilledDeltaFile

Deprecated Value Members

  1. def deltaFile(path: Path, version: Long): Path

    Returns the delta (json format) path for a given delta file.

    Returns the delta (json format) path for a given delta file. WARNING: This API is unsafe and deprecated. It can resolve to incorrect paths if the table has Managed Commits. It will be removed in future versions. Use DeltaCommitFileProvider(snapshot).deltaFile instead to guarantee accurate paths or unsafeDeltaFile for potentially incorrect file name resolution.

    Annotations
    @deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped