Packages

class AsyncOffsetSeqLog extends OffsetSeqLog

Used to write entries to the offset log asynchronously

Linear Supertypes
OffsetSeqLog, HDFSMetadataLog[OffsetSeq], Logging, MetadataLog[OffsetSeq], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AsyncOffsetSeqLog
  2. OffsetSeqLog
  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 AsyncOffsetSeqLog(sparkSession: SparkSession, path: String, executorService: ThreadPoolExecutor, offsetCommitIntervalMs: Long, clock: Clock = new SystemClock())

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def add(batchId: Long, metadata: OffsetSeq): 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
    HDFSMetadataLog → MetadataLog
  5. def addAsync(batchId: Long, metadata: OffsetSeq): CompletableFuture[(Long, Boolean)]

    Writes a new batch to the offset log asynchronously

    Writes a new batch to the offset log asynchronously

    batchId

    id of batch to write

    metadata

    metadata of batch to write

    returns

    a CompeletableFuture that contains the batch id. The future is completed when the async write of the batch is completed. Future may also be completed exceptionally to indicate some write error.

  6. def addNewBatchByStream(batchId: Long)(fn: (OutputStream) ⇒ Unit): 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. This method fills the content of metadata via executing function. If the function throws an exception, writing will be automatically cancelled and this method will propagate the exception.

    If the batchId's metadata has already been stored, this method will return false.

    Writing the metadata is done by writing a batch to a temp file then rename it to the batch file.

    There may be multiple HDFSMetadataLog using the same metadata path. Although it is not a valid behavior, we still need to prevent it from destroying the files.

    Definition Classes
    HDFSMetadataLog
  7. def applyFnToBatchByStream[RET](batchId: Long, skipExistingCheck: Boolean = false)(fn: (InputStream) ⇒ RET): RET

    Apply provided function to each entry in the specific batch metadata log.

    Apply provided function to each entry in the specific batch metadata log.

    Unlike get which will materialize all entries into memory, this method streamlines the process via READ-AND-PROCESS. This helps to avoid the memory issue on huge metadata log file.

    NOTE: This no longer fails early on corruption. The caller should handle the exception properly and make sure the logic is not affected by failing in the middle.

    Definition Classes
    HDFSMetadataLog
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. val batchCache: Map[Long, OffsetSeq]

    Cache the latest two batches.

    Cache the latest two batches. StreamExecution usually just accesses the latest two batches when committing offsets, this cache will save some file system operations.

    Attributes
    protected[sql]
    Definition Classes
    HDFSMetadataLog
  10. val batchFilesFilter: PathFilter

    A PathFilter to filter only batch files

    A PathFilter to filter only batch files

    Attributes
    protected
    Definition Classes
    HDFSMetadataLog
  11. def batchIdToPath(batchId: Long): Path
    Attributes
    protected
    Definition Classes
    HDFSMetadataLog
  12. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  13. def deserialize(in: InputStream): OffsetSeq

    Read and deserialize the metadata from input stream.

    Read and deserialize the metadata from input stream. If this method is overridden in a subclass, the overriding method should not close the given input stream, as it will be closed in the caller.

    Attributes
    protected
    Definition Classes
    OffsetSeqLog → HDFSMetadataLog
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  16. val fileManager: CheckpointFileManager
    Attributes
    protected
    Definition Classes
    HDFSMetadataLog
  17. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. def get(startId: Option[Long], endId: Option[Long]): Array[(Long, OffsetSeq)]

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

    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
  20. def getAsyncOffsetWrite(batchId: Long): Option[CompletableFuture[Long]]

    Get a async offset write by batch id.

    Get a async offset write by batch id. To check if a corresponding commit log entry needs to be written to durable storage as well

    returns

    a option to indicate whether a async offset write was issued for the batch with id

  21. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  22. def getLatest(): Option[(Long, OffsetSeq)]

    Return the latest batch Id and its metadata if exist.

    Return the latest batch Id and its metadata if exist.

    Definition Classes
    HDFSMetadataLog → MetadataLog
  23. def getLatestBatchId(): Option[Long]

    Return the latest batch id without reading the file.

    Return the latest batch id without reading the file.

    Definition Classes
    HDFSMetadataLog
  24. 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
  25. def getPrevBatchFromStorage(batchId: Long): Option[Long]

    Get the id of the previous batch from storage

    Get the id of the previous batch from storage

    batchId

    get the previous batch id of this batch with batchId

    Definition Classes
    HDFSMetadataLog
  26. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  27. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  28. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  29. def isBatchFile(path: Path): Boolean
    Attributes
    protected
    Definition Classes
    HDFSMetadataLog
  30. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  31. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  32. def listBatches: Array[Long]

    List the available batches on file system.

    List the available batches on file system.

    Attributes
    protected
    Definition Classes
    HDFSMetadataLog
  33. def listBatchesOnDisk: Array[Long]

    List the batches persisted to storage

    List the batches persisted to storage

    returns

    array of batches ids

    Definition Classes
    HDFSMetadataLog
  34. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  35. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  36. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  37. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  38. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  39. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  40. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  41. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  42. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  43. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  44. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  45. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  46. val metadataCacheEnabled: Boolean
    Attributes
    protected
    Definition Classes
    HDFSMetadataLog
  47. val metadataPath: Path
    Definition Classes
    HDFSMetadataLog
  48. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  49. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  50. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  51. def offsetSeqMetadataForBatchId(batchId: Long): Option[OffsetSeqMetadata]
    Definition Classes
    OffsetSeqLog
  52. def pathToBatchId(path: Path): Long
    Attributes
    protected
    Definition Classes
    HDFSMetadataLog
  53. def pendingAsyncOffsetWrite(): Int
  54. def purge(thresholdBatchId: Long): Unit

    Purge entries in the offset log up to thresholdBatchId.

    Purge entries in the offset log up to thresholdBatchId.

    Definition Classes
    AsyncOffsetSeqLog → HDFSMetadataLog → MetadataLog
  55. def purgeAfter(thresholdBatchId: Long): Unit

    Removes all log entries later than thresholdBatchId (exclusive).

    Removes all log entries later than thresholdBatchId (exclusive).

    Definition Classes
    HDFSMetadataLog
  56. def removeAsyncOffsetWrite(batchId: Long): Unit

    Remove the async offset write when we don't need to keep track of it anymore

  57. def serialize(offsetSeq: OffsetSeq, out: OutputStream): Unit

    Serialize the metadata and write to the output stream.

    Serialize the metadata and write to the output stream. If this method is overridden in a subclass, the overriding method should not close the given output stream, as it will be closed in the caller.

    Attributes
    protected
    Definition Classes
    OffsetSeqLog → HDFSMetadataLog
  58. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  59. def toString(): String
    Definition Classes
    AnyRef → Any
  60. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  61. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  62. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  63. def write(batchMetadataFile: Path, fn: (OutputStream) ⇒ Unit): Unit
    Attributes
    protected
    Definition Classes
    HDFSMetadataLog
  64. val writtenToDurableStorage: ConcurrentLinkedDeque[Long]

Inherited from OffsetSeqLog

Inherited from HDFSMetadataLog[OffsetSeq]

Inherited from Logging

Inherited from MetadataLog[OffsetSeq]

Inherited from AnyRef

Inherited from Any

Ungrouped