Struct DataFile

pub struct DataFile { /* private fields */ }

Data file carries data file path, partition tuple, metrics, …

Implementations

impl DataFile

pub fn content_type(&self) -> DataContentType

Get the content type of the data file (data, equality deletes, or position deletes)

pub fn file_path(&self) -> &str

Get the file path as full URI with FS scheme

pub fn file_format(&self) -> DataFileFormat

Get the file format of the file (avro, orc or parquet).

pub fn partition(&self) -> &Struct

Get the partition values of the file.

pub fn record_count(&self) -> u64

Get the record count in the data file.

pub fn file_size_in_bytes(&self) -> u64

Get the file size in bytes.

pub fn column_sizes(&self) -> &HashMap<i32, u64>

Get the column sizes. Map from column id to the total size on disk of all regions that store the column. Does not include bytes necessary to read other columns, like footers. Null for row-oriented formats (Avro)

pub fn value_counts(&self) -> &HashMap<i32, u64>

Get the columns value counts for the data file. Map from column id to number of values in the column (including null and NaN values)

pub fn null_value_counts(&self) -> &HashMap<i32, u64>

Get the null value counts of the data file. Map from column id to number of null values in the column

pub fn nan_value_counts(&self) -> &HashMap<i32, u64>

Get the nan value counts of the data file. Map from column id to number of NaN values in the column

pub fn lower_bounds(&self) -> &HashMap<i32, Datum>

Get the lower bounds of the data file values per column. Map from column id to lower bound in the column serialized as binary.

pub fn upper_bounds(&self) -> &HashMap<i32, Datum>

Get the upper bounds of the data file values per column. Map from column id to upper bound in the column serialized as binary.

pub fn key_metadata(&self) -> Option<&[u8]>

Get the Implementation-specific key metadata for the data file.

pub fn split_offsets(&self) -> &[i64]

Get the split offsets of the data file. For example, all row group offsets in a Parquet file.

pub fn equality_ids(&self) -> Option<Vec<i32>>

Get the equality ids of the data file. Field ids used to determine row equality in equality delete files. null when content is not EqualityDeletes.

pub fn first_row_id(&self) -> Option<i64>

Get the first row id in the data file.

pub fn sort_order_id(&self) -> Option<i32>

Get the sort order id of the data file. Only data files and equality delete files should be written with a non-null order id. Position deletes are required to be sorted by file and position, not a table order, and should set sort order id to null. Readers must ignore sort order id for position delete files.

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

Get the fully qualified referenced location for the corresponding data file. Positional delete files could have the field set, and deletion vectors must the field set.

pub fn content_offset(&self) -> Option<i64>

Get the offset in the file where the blob content starts. Only meaningful for puffin blobs, and required for deletion vectors.

pub fn content_size_in_bytes(&self) -> Option<i64>

Get the length of a puffin blob. Only meaningful for puffin blobs, and required for deletion vectors.

Trait Implementations

impl Clone for DataFile

fn clone(&self) -> DataFile

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DataFile

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

Formats the value using the given formatter.

impl PartialEq for DataFile

fn eq(&self, other: &DataFile) -> 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 Eq for DataFile

impl StructuralPartialEq for DataFile