t

org.apache.spark.sql.delta.hooks

PostCommitHook

trait PostCommitHook extends AnyRef

A hook which can be executed after a transaction. These hooks are registered to a OptimisticTransaction, and are executed after a *successful* commit takes place.

Linear Supertypes
AnyRef, Any
Known Subclasses
AutoCompact, AutoCompactBase, CheckpointHook, ChecksumHook, GenerateSymlinkManifest, GenerateSymlinkManifestImpl, HudiConverterHook, IcebergConverterHook, UpdateCatalog, UpdateCatalogBase
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PostCommitHook
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract val name: String

    A user friendly name for the hook for error reporting purposes.

  2. abstract def run(spark: SparkSession, txn: OptimisticTransactionImpl, committedVersion: Long, postCommitSnapshot: Snapshot, committedActions: Seq[Action]): Unit

    Executes the hook.

    Executes the hook.

    txn

    The txn that made the commit, after which this PostCommitHook was run

    committedVersion

    The version that was committed by the txn

    postCommitSnapshot

    the snapshot of the table after the txn successfully committed. NOTE: This may not match the committedVersion, if racing commits were written while the snapshot was computed.

    committedActions

    the actions that were committed in the txn. *May* be empty if the list of actions was too large.

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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def handleError(spark: SparkSession, error: Throwable, version: Long): Unit

    Handle any error caused while running the hook.

    Handle any error caused while running the hook. By default, all errors are ignored as default policy should be to not let post-commit hooks to cause failures in the operation.

  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped