Struct Add

pub struct Add {
    pub path: String,
    pub partition_values: HashMap<String, Option<String>>,
    pub size: i64,
    pub modification_time: i64,
    pub data_change: bool,
    pub stats: Option<String>,
    pub tags: Option<HashMap<String, Option<String>>>,
    pub deletion_vector: Option<DeletionVectorDescriptor>,
    pub base_row_id: Option<i64>,
    pub default_row_commit_version: Option<i64>,
    pub clustering_provider: Option<String>,
    pub stats_parsed: Option<Row>,
}

Defines an add action

Fields

path: String

A relative path to a data file from the root of the table or an absolute path to a file that should be added to the table. The path is a URI as specified by RFC 2396 URI Generic Syntax, which needs to be decoded to get the data file path.

partition_values: HashMap<String, Option<String>>

A map from partition column to value for this logical file.

size: i64

The size of this data file in bytes

modification_time: i64

The time this logical file was created, as milliseconds since the epoch.

data_change: bool

When false the logical file must already be present in the table or the records in the added file must be contained in one or more remove actions in the same version.

stats: Option<String>

Contains statistics (e.g., count, min/max values for columns) about the data in this logical file.

tags: Option<HashMap<String, Option<String>>>

Map containing metadata about this logical file.

deletion_vector: Option<DeletionVectorDescriptor>

Information about deletion vector (DV) associated with this add action

base_row_id: Option<i64>

Default generated Row ID of the first row in the file. The default generated Row IDs of the other rows in the file can be reconstructed by adding the physical index of the row within the file to the base Row ID

default_row_commit_version: Option<i64>

First commit version in which an add action with the same path was committed to the table.

clustering_provider: Option<String>

The name of the clustering implementation

stats_parsed: Option<Row>

Contains statistics (e.g., count, min/max values for columns) about the data in this file in raw parquet format. This field needs to be written when statistics are available and the table property: delta.checkpoint.writeStatsAsStruct is set to true.

This field is only available in add action records read from checkpoints

Implementations

impl Add

pub fn get_stats_parsed(&self) -> Result<Option<Stats>, ProtocolError>

Returns the composite HashMap representation of stats contained in the action if present. Since stats are defined as optional in the protocol, this may be None.

impl Add

pub fn get_json_stats(&self) -> Result<Option<Stats>, Error>

Returns the serde_json representation of stats contained in the action if present. Since stats are defined as optional in the protocol, this may be None.

Trait Implementations

impl Clone for Add

fn clone(&self) -> Add

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Add

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

Formats the value using the given formatter.

impl Default for Add

fn default() -> Add

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Add

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FileAction for Add

fn partition_values(&self) -> DeltaResult<&HashMap<String, Option<String>>>

Adds partition values

fn path(&self) -> String

Physical Path to the data

fn size(&self) -> DeltaResult<usize>

Byte size of the physical file

impl From<Add> for Action

fn from(a: Add) -> Self

Converts to this type from the input type.

impl Hash for Add

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Add

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Add

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&Add> for ObjectMeta

type Error = DeltaTableError

The type returned in the event of a conversion error.

fn try_from(value: &Add) -> DeltaResult<Self>

Performs the conversion.

impl TryFrom<Add> for ObjectMeta

type Error = DeltaTableError

The type returned in the event of a conversion error.

fn try_from(value: Add) -> DeltaResult<Self>

Performs the conversion.

impl Eq for Add