Package io.delta.kernel.hook

Enum PostCommitHook.PostCommitHookType

Object
Enum<PostCommitHook.PostCommitHookType>
io.delta.kernel.hook.PostCommitHook.PostCommitHookType
All Implemented Interfaces:
Serializable, Comparable<PostCommitHook.PostCommitHookType>
Enclosing interface:
PostCommitHook
public static enum PostCommitHook.PostCommitHookType extends Enum<PostCommitHook.PostCommitHookType>

  • Enum Constant Details

    • CHECKPOINT

      public static final PostCommitHook.PostCommitHookType CHECKPOINT
      Writes a new checkpoint at the version committed by the transaction. This hook is present when the table is ready for checkpoint according to its configured checkpoint interval. To perform this operation, reading previous checkpoint + logs is required to construct a new checkpoint, with latency scaling based on log size (typically seconds to minutes).

    • CHECKSUM_SIMPLE

      public static final PostCommitHook.PostCommitHookType CHECKSUM_SIMPLE
      Writes a checksum file at the version committed by the transaction. This hook is present when all required table statistics (e.g. table size) for checksum file are known when a transaction commits. This operation has a minimal latency with no requirement of reading previous checkpoint or logs.

    • CHECKSUM_FULL

      public static final PostCommitHook.PostCommitHookType CHECKSUM_FULL
      Writes a checksum file at the version committed by the transaction. This hook is present when CHECKSUM_SIMPLE is missing. It requires constructing table stats via full log replay, which can be expensive for large tables, with latency scaling based on log size. Unlike CHECKSUM_SIMPLE, this always performs a full table state construction rather than incrementally computing from a previous CRC.

    • LOG_COMPACTION

      public static final PostCommitHook.PostCommitHookType LOG_COMPACTION
      Writes a log compaction file that merges a range of commit JSON files into a single file. This hook is triggered on a configurable interval (e.g., every 10 commits) and reduces the number of small log files that need to be read when reconstructing the table state, thereby improving read performance.

  • Method Details

    • values

      public static PostCommitHook.PostCommitHookType[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static PostCommitHook.PostCommitHookType valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null