Enum DeltaOperation

pub enum DeltaOperation {
    AddColumn {
        fields: Vec<StructField>,
    },
    Create {
        mode: SaveMode,
        location: String,
        protocol: Protocol,
        metadata: Metadata,
    },
    Write {
        mode: SaveMode,
        partition_by: Option<Vec<String>>,
        predicate: Option<String>,
    },
    Delete {
        predicate: Option<String>,
    },
    Update {
        predicate: Option<String>,
    },
    AddConstraint {
        name: String,
        expr: String,
    },
    AddFeature {
        name: Vec<TableFeatures>,
    },
    DropConstraint {
        name: String,
    },
    Merge {
        predicate: Option<String>,
        merge_predicate: Option<String>,
        matched_predicates: Vec<MergePredicate>,
        not_matched_predicates: Vec<MergePredicate>,
        not_matched_by_source_predicates: Vec<MergePredicate>,
    },
    StreamingUpdate {
        output_mode: OutputMode,
        query_id: String,
        epoch_id: i64,
    },
    SetTableProperties {
        properties: HashMap<String, String>,
    },
    Optimize {
        predicate: Option<String>,
        target_size: i64,
    },
    FileSystemCheck {},
    Restore {
        version: Option<i64>,
        datetime: Option<i64>,
    },
    VacuumStart {
        retention_check_enabled: bool,
        specified_retention_millis: Option<i64>,
        default_retention_millis: i64,
    },
    VacuumEnd {
        status: String,
    },
}

Operation performed when creating a new log entry with one or more actions. This is a key element of the CommitInfo action.

Variants

AddColumn

Represents a Delta Add Column operation. Used to add new columns or field in a struct

Fields

fields: Vec<StructField>

Fields added to existing schema

Create

Represents a Delta Create operation. Would usually only create the table, if also data is written, a Write operations is more appropriate

Fields

mode: SaveMode

The save mode used during the create.

location: String

The storage location of the new table

protocol: Protocol

The min reader and writer protocol versions of the table

metadata: Metadata

Metadata associated with the new table

Write

Represents a Delta Write operation. Write operations will typically only include Add actions.

Fields

mode: SaveMode

The save mode used during the write.

partition_by: Option<Vec<String>>

The columns the write is partitioned by.

predicate: Option<String>

The predicate used during the write.

Delete

Delete data matching predicate from delta table

Fields

predicate: Option<String>

The condition the to be deleted data must match

Update

Update data matching predicate from delta table

Fields

predicate: Option<String>

The update predicate

AddConstraint

Add constraints to a table

Fields

name: String

Constraints name

expr: String

Expression to check against

AddFeature

Add table features to a table

Fields

name: Vec<TableFeatures>

Name of the feature

DropConstraint

Drops constraints from a table

Fields

name: String

Constraints name

Merge

Merge data with a source data with the following predicate

Fields

predicate: Option<String>

Cleaned merge predicate for conflict checks

merge_predicate: Option<String>

The original merge predicate

matched_predicates: Vec<MergePredicate>

Match operations performed

not_matched_predicates: Vec<MergePredicate>

Not Match operations performed

not_matched_by_source_predicates: Vec<MergePredicate>

Not Match by Source operations performed

StreamingUpdate

Represents a Delta StreamingUpdate operation.

Fields

output_mode: OutputMode

The output mode the streaming writer is using.

query_id: String

The query id of the streaming writer.

epoch_id: i64

The epoch id of the written micro-batch.

SetTableProperties

Set table properties operations

Fields

properties: HashMap<String, String>

Table properties that were added

Optimize

Represents a Optimize operation

Fields

predicate: Option<String>

The filter used to determine which partitions to filter

target_size: i64

Target optimize size

FileSystemCheck

Represents a FileSystemCheck operation

Restore

Represents a Restore operation

Fields

version: Option<i64>

Version to restore

datetime: Option<i64>

Datetime to restore

VacuumStart

Represents the start of Vacuum operation

Fields

retention_check_enabled: bool

Whether the retention check is enforced

specified_retention_millis: Option<i64>

The specified retetion period in milliseconds

default_retention_millis: i64

The default delta table retention milliseconds policy

VacuumEnd

Represents the end of Vacuum operation

Fields

status: String

The status of the operation

Implementations

impl DeltaOperation

pub fn name(&self) -> &str

A human readable name for the operation

pub fn operation_parameters(&self) -> DeltaResult<HashMap<String, Value>>

Parameters configured for operation.

pub fn changes_data(&self) -> bool

Denotes if the operation changes the data contained in the table

pub fn get_commit_info(&self) -> CommitInfo

Retrieve basic commit information to be added to Delta commits

pub fn read_predicate(&self) -> Option<String>

Get predicate expression applied when the operation reads data from the table.

pub fn read_whole_table(&self) -> bool

Denotes if the operation reads the entire table

Trait Implementations

impl Clone for DeltaOperation

fn clone(&self) -> DeltaOperation

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DeltaOperation

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DeltaOperation

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DeltaOperation

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.