Interface TruncatableTable

All Superinterfaces:
Relation, Table
All Known Subinterfaces:
SupportsDelete, SupportsDeleteV2

@Evolving public interface TruncatableTable extends Table
Represents a table which can be atomically truncated.
Since:
3.2.0
  • Method Details

    • truncateTable

      boolean truncateTable()
      Truncate a table by removing all rows from the table atomically.
      Returns:
      true if a table was truncated successfully otherwise false
      Since:
      3.2.0
    • truncateTable

      default boolean truncateTable(CaseInsensitiveStringMap options)
      Truncate a table with per-statement options from a DELETE ... WITH (key=value) clause.

      The default implementation ignores options and delegates to truncateTable(), which preserves backward compatibility for connectors that do not need per-statement options.

      Parameters:
      options - per-statement options from the WITH clause; empty if none were given
      Returns:
      true if the table was truncated successfully, false otherwise
      Since:
      4.3.0
    • supportedCustomMetrics

      default CustomMetric[] supportedCustomMetrics()
      Returns an array of supported custom metrics with name and description. By default it returns empty array.
      Since:
      4.2.0
    • reportDriverMetrics

      default CustomTaskMetric[] reportDriverMetrics()
      Returns an array of custom metrics which are collected with values at the driver side only. Note that these metrics must be included in the supported custom metrics reported by `supportedCustomMetrics`.
      Since:
      4.2.0