t

org.apache.spark.sql.delta.managedcommit

AbstractBatchBackfillingCommitOwnerClient

trait AbstractBatchBackfillingCommitOwnerClient extends CommitOwnerClient with Logging

An abstract CommitOwnerClient which triggers backfills every n commits. - every commit version which satisfies commitVersion % batchSize == 0 will trigger a backfill.

Linear Supertypes
Logging, CommitOwnerClient, AnyRef, Any
Known Subclasses
InMemoryCommitOwner
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AbstractBatchBackfillingCommitOwnerClient
  2. Logging
  3. CommitOwnerClient
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract val batchSize: Long

    Size of batch that should be backfilled.

    Size of batch that should be backfilled. So every commit version which satisfies commitVersion % batchSize == 0 will trigger a backfill.

  2. abstract def getCommits(logPath: Path, managedCommitTableConf: Map[String, String], startVersion: Long, endVersion: Option[Long] = None): GetCommitsResponse

    API to get the un-backfilled commits for the table represented by the given logPath.

    API to get the un-backfilled commits for the table represented by the given logPath. Commits older than startVersion, or newer than endVersion (if given), are ignored. The returned commits are contiguous and in ascending version order. Note that the first version returned by this API may not be equal to the startVersion. This happens when few versions starting from startVersion are already backfilled and so commit-owner may have stopped tracking them. The returned latestTableVersion is the maximum commit version ratified by the Commit-Owner. Note that returning latestTableVersion as -1 is acceptable only if the commit-owner never ratified any version i.e. it never accepted any un-backfilled commit.

    returns

    GetCommitsResponse which has a list of Commits and the latestTableVersion which is tracked by CommitOwnerClient.

    Definition Classes
    CommitOwnerClient
  3. abstract def registerBackfill(logPath: Path, backfilledVersion: Long): Unit

    Callback to tell the CommitOwner that all commits <= backfilledVersion are backfilled.

    Callback to tell the CommitOwner that all commits <= backfilledVersion are backfilled.

    Attributes
    protected[delta]
  4. abstract def semanticEquals(other: CommitOwnerClient): Boolean

    Determines whether this CommitOwnerClient is semantically equal to another CommitOwnerClient.

    Determines whether this CommitOwnerClient is semantically equal to another CommitOwnerClient.

    Semantic equality is determined by each CommitOwnerClient implementation based on whether the two instances can be used interchangeably when invoking any of the CommitOwnerClient APIs, such as commit, getCommits, etc. For e.g., both the instances might be pointing to the same underlying endpoint.

    Definition Classes
    CommitOwnerClient

Concrete 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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def backfill(logStore: LogStore, hadoopConf: Configuration, logPath: Path, version: Long, fileStatus: FileStatus): Unit

    Backfills a given fileStatus to version.json

    Backfills a given fileStatus to version.json

    Attributes
    protected
  6. def backfillToVersion(logStore: LogStore, hadoopConf: Configuration, logPath: Path, managedCommitTableConf: Map[String, String], startVersion: Long = 0, endVersionOpt: Option[Long] = None): Unit

    API to ask the Commit-Owner to backfill all commits >= 'startVersion' and <= endVersion.

    API to ask the Commit-Owner to backfill all commits >= 'startVersion' and <= endVersion.

    If this API returns successfully, that means the backfill must have been completed, although the Commit-Owner may not be aware of it yet.

    Definition Classes
    AbstractBatchBackfillingCommitOwnerClient → CommitOwnerClient
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  8. def commit(logStore: LogStore, hadoopConf: Configuration, logPath: Path, managedCommitTableConf: Map[String, String], commitVersion: Long, actions: Iterator[String], updatedActions: UpdatedActions): CommitResponse

    API to commit the given set of actions to the table represented by given logPath at the given commitVersion.

    API to commit the given set of actions to the table represented by given logPath at the given commitVersion.

    returns

    CommitResponse which contains the file status of the commit file. If the commit is already backfilled, then the fileStatus could be omitted from response and the client could get the info by themselves.

    Definition Classes
    AbstractBatchBackfillingCommitOwnerClient → CommitOwnerClient
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  11. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. def generateUUID(): String
    Attributes
    protected
  13. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. def getTablePath(logPath: Path): Path
    Attributes
    protected
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  17. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  20. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  21. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  22. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  23. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  24. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  25. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  26. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  27. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  28. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  29. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  30. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  31. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  32. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  33. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  34. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  35. def registerTable(logPath: Path, currentVersion: Long, currentMetadata: Metadata, currentProtocol: Protocol): Map[String, String]

    API to register the table represented by the given logPath with the given currentTableVersion.

    API to register the table represented by the given logPath with the given currentTableVersion. This API is called when the table is being converted from filesystem table to managed-commit table. - The currentTableVersion is the version of the table just before conversion. - The currentTableVersion + 1 represents the commit that will do the conversion. This must be backfilled atomically. - The currentTableVersion + 2 represents the first commit after conversion. This will go via the CommitOwnerClient and it could choose whether it wants to write unbackfilled commits and backfill them later. When a new managed-commit table is being created, the currentTableVersion will be -1 and the upgrade commit needs to be a file-system commit which will write the backfilled file directly.

    returns

    A map of key-value pairs which is issued by the commit-owner to identify the table. This should be stored in the table's metadata. This information needs to be passed in other table specific APIs like commit / getCommits / backfillToVersion to identify the table.

    Definition Classes
    CommitOwnerClient
  36. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  37. def toString(): String
    Definition Classes
    AnyRef → Any
  38. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  40. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  41. def writeCommitFile(logStore: LogStore, hadoopConf: Configuration, logPath: Path, commitVersion: Long, actions: Iterator[String]): FileStatus
    Attributes
    protected

Inherited from Logging

Inherited from CommitOwnerClient

Inherited from AnyRef

Inherited from Any

Ungrouped