Class/Object

org.apache.spark.sql.execution.streaming

HDFSMetadataLog

Related Docs: object HDFSMetadataLog | package streaming

Permalink

class HDFSMetadataLog[T] extends MetadataLog[T] with 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
Logging, MetadataLog[T], AnyRef, Any
Known Subclasses
CompactibleFileStreamLog, FileStreamSinkLog, FileStreamSourceLog
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.

    Note that this method must be called on a org.apache.spark.util.UninterruptibleThread so that interrupts can be disabled while writing the batch file. This is because there is a potential dead-lock in Hadoop "Shell.runCommand" before 2.5.0 (HADOOP-10622). If the thread running "Shell.runCommand" is interrupted, then the thread can get deadlocked. In our case, writeBatch creates a file using HDFS API and calls "Shell.runCommand" to set the file permissions, and can get deadlocked if the stream execution thread is stopped by interrupt. Hence, we make sure that this method is called on UninterruptibleThread which allows us to disable interrupts here. Also see SPARK-14131.

    Definition Classes
    HDFSMetadataLog → MetadataLog

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  6. def batchIdToPath(batchId: Long): Path

    Permalink
    Attributes
    protected

  7. def clone(): AnyRef

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

  8. def deserialize(in: InputStream): T

    Permalink
    Attributes
    protected

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

    Permalink
    Definition Classes
    AnyRef

  10. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  11. val fileManager: FileManager

    Permalink
    Attributes
    protected

  12. def finalize(): Unit

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

  13. 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

  14. 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

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

    Permalink
    Definition Classes
    AnyRef → Any

  16. 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

  17. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  18. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  19. def isBatchFile(path: Path): Boolean

    Permalink
    Attributes
    protected

  20. final def isDebugEnabled: Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  21. final def isInfoEnabled: Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  22. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  23. final def isTraceEnabled: Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  24. def log: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  31. def logName: String

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  36. val metadataPath: Path

    Permalink

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

    Permalink
    Definition Classes
    AnyRef

  38. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  39. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  40. def pathToBatchId(path: Path): Long

    Permalink
    Attributes
    protected

  41. 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

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

    Permalink
    Attributes
    protected

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

    Permalink
    Definition Classes
    AnyRef

  44. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  45. final def wait(): Unit

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

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

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

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

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

Inherited from Logging

Inherited from MetadataLog[T]

Inherited from AnyRef

Inherited from Any

Ungrouped