Package io.delta.kernel.metrics

Interface TransactionReport

All Superinterfaces:
DeltaOperationReport, MetricsReport
public interface TransactionReport extends DeltaOperationReport
Defines the metadata and metrics for a transaction MetricsReport

  • Method Details

    • getOperation

      String getOperation()
      Returns:
      The Operation provided when the transaction was created using Table.createTransactionBuilder(io.delta.kernel.engine.Engine, java.lang.String, io.delta.kernel.Operation).

    • getEngineInfo

      String getEngineInfo()
      Returns:
      The engineInfo provided when the transaction was created using Table.createTransactionBuilder(io.delta.kernel.engine.Engine, java.lang.String, io.delta.kernel.Operation).

    • getBaseSnapshotVersion

      long getBaseSnapshotVersion()
      The version of the table the transaction was created from. For example, if the latest table version is 4 when the transaction is created, the transaction is based off of the snapshot of the table at version 4. For a new table (e.g. a transaction that is creating a table) this is -1.
      Returns:
      the table version of the snapshot the transaction was started from

    • getClusteringColumns

      List<Column> getClusteringColumns()
      Get the list of clustering columns the table data is expected to be clustered by. This is optional because clustering columns are not always defined for a table. Consumers of the transaction report trigger clustering operations based on this list.
      Returns:
      list of clustering columns for the table. The columns are physical names of how the data is written in the data files. Each column can contain one or more elements representing the hierarchy of the column names in case of nested columns.

    • getSnapshotReportUUID

      Optional<UUID> getSnapshotReportUUID()
      Returns:
      the DeltaOperationReport.getReportUUID() of the SnapshotReport for the transaction's snapshot construction. Empty for a new table transaction.

    • getCommittedVersion

      Optional<Long> getCommittedVersion()
      Returns:
      the version committed to the table in this transaction. Empty for a failed transaction.

    • getTransactionMetrics

      TransactionMetricsResult getTransactionMetrics()
      Returns:
      the metrics for this transaction

    • getOperationType

      default String getOperationType()
      Specified by:
      getOperationType in interface DeltaOperationReport
      Returns:
      a string representation of the operation this report is for