Class/Object

org.apache.spark.sql.execution.streaming

HDFSMetadataLog

Related Docs: object HDFSMetadataLog | package streaming

Permalink

class HDFSMetadataLog[T <: AnyRef] extends MetadataLog[T] with internal.Logging

A MetadataLog implementation based on HDFS. HDFSMetadataLog uses the specified path as the metadata storage.

When writing a new batch, HDFSMetadataLog will firstly write to a temp file and then rename it to the final batch file. If the rename step fails, there must be multiple writers and only one of them will succeed and the others will fail.

Note: HDFSMetadataLog doesn't support S3-like file systems as they don't guarantee listing files in a directory always shows the latest files.

Linear Supertypes
internal.Logging, MetadataLog[T], AnyRef, Any
Known Subclasses
CompactibleFileStreamLog, FileStreamSinkLog, FileStreamSourceLog, OffsetSeqLog
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HDFSMetadataLog
  2. Logging
  3. MetadataLog
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new HDFSMetadataLog(sparkSession: SparkSession, path: String)(implicit arg0: ClassTag[T])

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. def add(batchId: Long, metadata: T): Boolean

    Permalink

    Store the metadata for the specified batchId and return true if successful.

    Store the metadata for the specified batchId and return true if successful. If the batchId's metadata has already been stored, this method will return false.

    Definition Classes
    HDFSMetadataLog → MetadataLog

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  6. val batchFilesFilter: PathFilter

    Permalink

    A PathFilter to filter only batch files

    A PathFilter to filter only batch files

    Attributes
    protected

  7. def batchIdToPath(batchId: Long): Path

    Permalink
    Attributes
    protected

  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  9. def deserialize(in: InputStream): T

    Permalink
    Attributes
    protected

  10. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  11. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  12. val fileManager: FileManager

    Permalink
    Attributes
    protected

  13. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  14. def get(startId: Option[Long], endId: Option[Long]): Array[(Long, T)]

    Permalink

    Return metadata for batches between startId (inclusive) and endId (inclusive).

    Return metadata for batches between startId (inclusive) and endId (inclusive). If startId is None, just return all batches before endId (inclusive).

    Definition Classes
    HDFSMetadataLog → MetadataLog

  15. def get(batchId: Long): Option[T]

    Permalink

    Return the metadata for the specified batchId if it's stored.

    Return the metadata for the specified batchId if it's stored. Otherwise, return None.

    Definition Classes
    HDFSMetadataLog → MetadataLog

  16. def get(batchFile: Path): Option[T]

    Permalink

    returns

    the deserialized metadata in a batch file, or None if file not exist.

    Exceptions thrown

    IllegalArgumentException when path does not point to a batch file.

  17. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  18. def getLatest(): Option[(Long, T)]

    Permalink

    Return the latest batch Id and its metadata if exist.

    Return the latest batch Id and its metadata if exist.

    Definition Classes
    HDFSMetadataLog → MetadataLog

  19. def getOrderedBatchFiles(): Array[FileStatus]

    Permalink

    Get an array of [FileStatus] referencing batch files.

    Get an array of [FileStatus] referencing batch files. The array is sorted by most recent batch file first to oldest batch file.

  20. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  21. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean = false): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  22. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  23. def isBatchFile(path: Path): Boolean

    Permalink
    Attributes
    protected

  24. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  25. def isTraceEnabled(): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  26. def log: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  27. def logDebug(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  28. def logDebug(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  29. def logError(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  30. def logError(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  31. def logInfo(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  32. def logInfo(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  33. def logName: String

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  34. def logTrace(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  35. def logTrace(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  36. def logWarning(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  37. def logWarning(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  38. val metadataPath: Path

    Permalink

  39. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  40. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  41. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  42. def pathToBatchId(path: Path): Long

    Permalink
    Attributes
    protected

  43. def purge(thresholdBatchId: Long): Unit

    Permalink

    Removes all the log entry earlier than thresholdBatchId (exclusive).

    Removes all the log entry earlier than thresholdBatchId (exclusive).

    Definition Classes
    HDFSMetadataLog → MetadataLog

  44. def serialize(metadata: T, out: OutputStream): Unit

    Permalink
    Attributes
    protected

  45. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  46. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  47. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  48. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  49. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from internal.Logging

Inherited from MetadataLog[T]

Inherited from AnyRef

Inherited from Any

Ungrouped