Class/Object

org.apache.spark.sql.execution.streaming

FileStreamSinkLog

Related Docs: object FileStreamSinkLog | package streaming

Permalink

class FileStreamSinkLog extends CompactibleFileStreamLog[SinkFileStatus]

A special log for FileStreamSink. It will write one log file for each batch. The first line of the log file is the version number, and there are multiple JSON lines following. Each JSON line is a JSON format of SinkFileStatus.

As reading from many small files is usually pretty slow, FileStreamSinkLog will compact log files every "spark.sql.sink.file.log.compactLen" batches into a big file. When doing a compaction, it will read all old log files and merge them with the new batch. During the compaction, it will also delete the files that are deleted (marked by SinkFileStatus.action). When the reader uses allFiles to list all files, this method only returns the visible files (drops the deleted files).

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FileStreamSinkLog
  2. CompactibleFileStreamLog
  3. HDFSMetadataLog
  4. Logging
  5. MetadataLog
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new FileStreamSinkLog(metadataLogVersion: String, sparkSession: SparkSession, path: String)

    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, logs: Array[SinkFileStatus]): 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
    CompactibleFileStreamLogHDFSMetadataLogMetadataLog
  5. def allFiles(): Array[SinkFileStatus]

    Permalink

    Returns all files except the deleted ones.

    Returns all files except the deleted ones.

    Definition Classes
    CompactibleFileStreamLog
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def batchIdToPath(batchId: Long): Path

    Permalink
  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. val compactInterval: Int

    Permalink
    Attributes
    protected
    Definition Classes
    FileStreamSinkLogCompactibleFileStreamLog
  10. def compactLogs(logs: Seq[SinkFileStatus]): Seq[SinkFileStatus]

    Permalink

    Filter out the obsolete logs.

    Filter out the obsolete logs.

    Definition Classes
    FileStreamSinkLogCompactibleFileStreamLog
  11. def deserialize(in: InputStream): Array[SinkFileStatus]

    Permalink
  12. def deserializeData(encodedString: String): SinkFileStatus

    Permalink

    Deserialize the string into data object.

    Deserialize the string into data object.

    Attributes
    protected
    Definition Classes
    FileStreamSinkLogCompactibleFileStreamLog
  13. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  14. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  15. val fileCleanupDelayMs: Long

    Permalink

    If we delete the old files after compaction at once, there is a race condition in S3: other processes may see the old files are deleted but still cannot see the compaction file using "list".

    If we delete the old files after compaction at once, there is a race condition in S3: other processes may see the old files are deleted but still cannot see the compaction file using "list". The allFiles handles this by looking for the next compaction file directly, however, a live lock may happen if the compaction happens too frequently: one processing keeps deleting old files while another one keeps retrying. Setting a reasonable cleanup delay could avoid it.

    Attributes
    protected
    Definition Classes
    FileStreamSinkLogCompactibleFileStreamLog
  16. val fileManager: FileManager

    Permalink
    Attributes
    protected
    Definition Classes
    HDFSMetadataLog
  17. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. def get(startId: Option[Long], endId: Option[Long]): Array[(Long, Array[SinkFileStatus])]

    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
    HDFSMetadataLogMetadataLog
  19. def get(batchId: Long): Option[Array[SinkFileStatus]]

    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
    HDFSMetadataLogMetadataLog
  20. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  21. def getLatest(): Option[(Long, Array[SinkFileStatus])]

    Permalink

    Return the latest batch Id and its metadata if exist.

    Return the latest batch Id and its metadata if exist.

    Definition Classes
    HDFSMetadataLogMetadataLog
  22. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  23. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  24. def isBatchFile(path: Path): Boolean

    Permalink
  25. final def isDebugEnabled: Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  26. val isDeletingExpiredLog: Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    FileStreamSinkLogCompactibleFileStreamLog
  27. final def isInfoEnabled: Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  28. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  29. final def isTraceEnabled: Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  30. def log: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  31. def logDebug(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  32. def logDebug(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  33. def logError(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  34. def logError(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  35. def logInfo(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  36. def logInfo(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  37. def logName: String

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  38. def logTrace(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  39. def logTrace(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  40. def logWarning(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  41. def logWarning(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  42. val metadataPath: Path

    Permalink
    Definition Classes
    HDFSMetadataLog
  43. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  44. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  45. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  46. def pathToBatchId(path: Path): Long

    Permalink
  47. 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
    HDFSMetadataLogMetadataLog
  48. def serialize(logData: Array[SinkFileStatus], out: OutputStream): Unit

    Permalink
  49. def serializeData(data: SinkFileStatus): String

    Permalink

    Serialize the data into encoded string.

    Serialize the data into encoded string.

    Attributes
    protected
    Definition Classes
    FileStreamSinkLogCompactibleFileStreamLog
  50. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  51. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  52. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  53. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  54. final def wait(arg0: Long): Unit

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

Inherited from HDFSMetadataLog[Array[SinkFileStatus]]

Inherited from Logging

Inherited from MetadataLog[Array[SinkFileStatus]]

Inherited from AnyRef

Inherited from Any

Ungrouped