org.apache.spark.sql.execution.streaming

BatchCommitLog

class BatchCommitLog extends HDFSMetadataLog[String]

Used to write log files that represent batch commit points in structured streaming. A commit log file will be written immediately after the successful completion of a batch, and before processing the next batch. Here is an execution summary: - trigger batch 1 - obtain batch 1 offsets and write to offset log - process batch 1 - write batch 1 to completion log - trigger batch 2 - obtain bactch 2 offsets and write to offset log - process batch 2 - write batch 2 to completion log ....

The current format of the batch completion log is: line 1: version line 2: metadata (optional json string)

Linear Supertypes
HDFSMetadataLog[String], Logging, MetadataLog[String], AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. BatchCommitLog
  2. HDFSMetadataLog
  3. Logging
  4. MetadataLog
  5. AnyRef
  6. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new BatchCommitLog(sparkSession: SparkSession, path: String)

Value Members

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

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  6. def add(batchId: Long, metadata: String): Boolean

    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
    BatchCommitLog → HDFSMetadataLog → MetadataLog

  7. def add(batchId: Long): Unit

  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  9. val batchFilesFilter: PathFilter

    A PathFilter to filter only batch files

    A PathFilter to filter only batch files

    Attributes
    protected
    Definition Classes
    HDFSMetadataLog

  10. def batchIdToPath(batchId: Long): Path

    Attributes
    protected
    Definition Classes
    HDFSMetadataLog

  11. def clone(): AnyRef

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

  12. def deserialize(in: InputStream): String

    Attributes
    protected
    Definition Classes
    BatchCommitLog → HDFSMetadataLog

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

    Definition Classes
    AnyRef

  14. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  15. val fileManager: FileManager

    Attributes
    protected
    Definition Classes
    HDFSMetadataLog

  16. def finalize(): Unit

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

  17. def get(startId: Option[Long], endId: Option[Long]): Array[(Long, String)]

    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

  18. def get(batchId: Long): Option[String]

    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

  19. def get(batchFile: Path): Option[String]

    returns

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

    Definition Classes
    HDFSMetadataLog
    Exceptions thrown
    IllegalArgumentException

    when path does not point to a batch file.

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

    Definition Classes
    AnyRef → Any

  21. def getLatest(): Option[(Long, String)]

    Return the latest batch Id and its metadata if exist.

    Return the latest batch Id and its metadata if exist.

    Definition Classes
    HDFSMetadataLog → MetadataLog

  22. def getOrderedBatchFiles(): Array[FileStatus]

    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.

    Definition Classes
    HDFSMetadataLog

  23. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  24. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    Attributes
    protected
    Definition Classes
    Logging

  25. def isBatchFile(path: Path): Boolean

    Attributes
    protected
    Definition Classes
    HDFSMetadataLog

  26. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  27. def isTraceEnabled(): Boolean

    Attributes
    protected
    Definition Classes
    Logging

  28. def log: Logger

    Attributes
    protected
    Definition Classes
    Logging

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

    Attributes
    protected
    Definition Classes
    Logging

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

    Attributes
    protected
    Definition Classes
    Logging

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

    Attributes
    protected
    Definition Classes
    Logging

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

    Attributes
    protected
    Definition Classes
    Logging

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

    Attributes
    protected
    Definition Classes
    Logging

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

    Attributes
    protected
    Definition Classes
    Logging

  35. def logName: String

    Attributes
    protected
    Definition Classes
    Logging

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

    Attributes
    protected
    Definition Classes
    Logging

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

    Attributes
    protected
    Definition Classes
    Logging

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

    Attributes
    protected
    Definition Classes
    Logging

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

    Attributes
    protected
    Definition Classes
    Logging

  40. val metadataPath: Path

    Definition Classes
    HDFSMetadataLog

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

    Definition Classes
    AnyRef

  42. final def notify(): Unit

    Definition Classes
    AnyRef

  43. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  44. def pathToBatchId(path: Path): Long

    Attributes
    protected
    Definition Classes
    HDFSMetadataLog

  45. def purge(thresholdBatchId: Long): Unit

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

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

    Definition Classes
    HDFSMetadataLog → MetadataLog

  46. def serialize(metadata: String, out: OutputStream): Unit

    Attributes
    protected
    Definition Classes
    BatchCommitLog → HDFSMetadataLog

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

    Definition Classes
    AnyRef

  48. def toString(): String

    Definition Classes
    AnyRef → Any

  49. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from HDFSMetadataLog[String]

Inherited from Logging

Inherited from MetadataLog[String]

Inherited from AnyRef

Inherited from Any

Ungrouped