object FileNames
Helper for creating file names for specific commits / checkpoints.
- Alphabetic
- By Inheritance
- FileNames
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val COMMIT_SUBDIR: String
- val SIDECAR_SUBDIR: String
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- val checkpointFileRegex: Regex
- 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.
- 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.
- def checkpointVersion(file: FileStatus): Long
- def checkpointVersion(path: Path): Long
- def checksumFile(path: Path, version: Long): Path
Returns the path to the checksum file for the given version.
- val checksumFileRegex: Regex
- def checksumVersion(file: FileStatus): Long
- def checksumVersion(path: Path): Long
Returns the version for the given checksum file.
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def commitDirPath(logPath: Path): Path
Returns path to the sidecar directory
- def compactedDeltaFile(path: Path, fromVersion: Long, toVersion: Long): Path
Returns the path to the compacted delta file for the given version range.
- val compactedDeltaFileRegex: Regex
- def compactedDeltaVersions(file: FileStatus): (Long, Long)
- def compactedDeltaVersions(path: Path): (Long, Long)
- val deltaFileRegex: Regex
- def deltaVersion(file: FileStatus): Long
- def deltaVersion(path: Path): Long
Returns the version for the given delta path.
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def getFileVersion(file: FileStatus): Long
- 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.
- 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.
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def isBackfilledDeltaFile(file: FileStatus): Boolean
- def isBackfilledDeltaFile(path: Path): Boolean
- def isCheckpointFile(file: FileStatus): Boolean
- def isCheckpointFile(path: Path): Boolean
- def isChecksumFile(file: FileStatus): Boolean
- def isChecksumFile(path: Path): Boolean
- def isCompactedDeltaFile(file: FileStatus): Boolean
- def isCompactedDeltaFile(path: Path): Boolean
- def isDeltaFile(file: FileStatus): Boolean
- def isDeltaFile(path: Path): Boolean
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isUnbackfilledDeltaFile(file: FileStatus): Boolean
- def isUnbackfilledDeltaFile(path: Path): Boolean
- 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.
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def newV2CheckpointJsonFile(path: Path, version: Long): Path
File path for a new V2 Checkpoint Json file
- def newV2CheckpointParquetFile(path: Path, version: Long): Path
File path for a new V2 Checkpoint Parquet file
- def newV2CheckpointSidecarFile(logPath: Path, version: Long, numParts: Int, currentPart: Int): Path
File path for a V2 Checkpoint's Sidecar file
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def numCheckpointParts(path: Path): Option[Int]
- def sampleFile(path: Path, version: Long): Path
Returns the path for a given sample file
- def sidecarDirPath(logPath: Path): Path
Returns path to the sidecar directory
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- 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
- 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 Coordinated Commits. Use DeltaCommitFileProvider(snapshot).deltaFile instead to guarantee accurate paths.
- val uuidDeltaFileRegex: Regex
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- object BackfilledDeltaFile
- object CheckpointFile
- object ChecksumFile
- object CompactedDeltaFile
- object DeltaFile
- object FileType extends Enumeration
- object UnbackfilledDeltaFile