Struct TableConfig

pub struct TableConfig<'a>(/* private fields */);

Well known delta table configuration

Implementations

impl TableConfig<'_>

pub fn append_only(&self) -> bool

true for this Delta table to be append-only

pub fn write_stats_as_json(&self) -> bool

true for Delta Lake to write file statistics in checkpoints in JSON format for the stats column.

pub fn write_stats_as_struct(&self) -> bool

true for Delta Lake to write file statistics to checkpoints in struct format

pub fn target_file_size(&self) -> i64

The target file size in bytes or higher units for file tuning

pub fn enable_change_data_feed(&self) -> bool

true to enable change data feed.

pub fn enable_deletion_vectors(&self) -> bool

true to enable deletion vectors and predictive I/O for updates.

pub fn num_indexed_cols(&self) -> i32

The number of columns for Delta Lake to collect statistics about for data skipping.

pub fn enable_expired_log_cleanup(&self) -> bool

whether to cleanup expired logs

pub fn checkpoint_interval(&self) -> i32

Interval (number of commits) after which a new checkpoint should be created

pub fn deleted_file_retention_duration(&self) -> Duration

The shortest duration for Delta Lake to keep logically deleted data files before deleting them physically. This is to prevent failures in stale readers after compactions or partition overwrites.

This value should be large enough to ensure that:

• It is larger than the longest possible duration of a job if you run VACUUM when there are concurrent readers or writers accessing the Delta table.
• If you run a streaming query that reads from the table, that query does not stop for longer than this value. Otherwise, the query may not be able to restart, as it must still read old files.

pub fn log_retention_duration(&self) -> Duration

How long the history for a Delta table is kept.

Each time a checkpoint is written, Delta Lake automatically cleans up log entries older than the retention interval. If you set this property to a large enough value, many log entries are retained. This should not impact performance as operations against the log are constant time. Operations on history are parallel but will become more expensive as the log size increases.

pub fn isolation_level(&self) -> IsolationLevel

The degree to which a transaction must be isolated from modifications made by concurrent transactions.

Valid values are Serializable and WriteSerializable.

pub fn checkpoint_policy(&self) -> CheckpointPolicy

Policy applied during chepoint creation

pub fn column_mapping_mode(&self) -> ColumnMappingMode

Return the column mapping mode according to delta.columnMapping.mode

pub fn get_constraints(&self) -> Vec<Constraint>

Return the check constraints on the current table

pub fn stats_columns(&self) -> Option<Vec<&str>>

Column names on which Delta Lake collects statistics to enhance data skipping functionality. This property takes precedence over num_indexed_cols.

Trait Implementations

impl<'a> Debug for TableConfig<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.