Package org.apache.spark.sql.connector.catalog

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 Summary

Modifier and Type	Method	Description
default CustomTaskMetric[]	reportDriverMetrics()	Returns an array of custom metrics which are collected with values at the driver side only.
default CustomMetric[]	supportedCustomMetrics()	Returns an array of supported custom metrics with name and description.
boolean	truncateTable()	Truncate a table by removing all rows from the table atomically.

Methods inherited from interface org.apache.spark.sql.connector.catalog.Table

capabilities, columns, constraints, id, name, partitioning, properties, schema, version

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

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