Struct DeltaScanConfigBuilder

pub struct DeltaScanConfigBuilder { /* private fields */ }

Used to specify if additional metadata columns are exposed to the user

Implementations

impl DeltaScanConfigBuilder

pub fn new() -> Self

Construct a new instance of DeltaScanConfigBuilder

pub fn with_file_column(self, include: bool) -> Self

Indicate that a column containing a records file path is included. Column name is generated and can be determined once this Config is built

pub fn with_file_column_name<S: ToString>(self, name: &S) -> Self

Indicate that a column containing a records file path is included and column name is user defined.

pub fn wrap_partition_values(self, wrap: bool) -> Self

Whether to wrap partition values in a dictionary encoding

pub fn with_parquet_pushdown(self, pushdown: bool) -> Self

Allow pushdown of the scan filter When disabled the filter will only be used for pruning files

pub fn with_schema(self, schema: SchemaRef) -> Self

Use the provided SchemaRef for the DeltaScan

pub fn build(&self, snapshot: &DeltaTableState) -> DeltaResult<DeltaScanConfig>

Build a DeltaScanConfig and ensure no column name conflicts occur during downstream processing

Trait Implementations

impl Clone for DeltaScanConfigBuilder

fn clone(&self) -> DeltaScanConfigBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DeltaScanConfigBuilder

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

Formats the value using the given formatter.

impl Default for DeltaScanConfigBuilder

fn default() -> Self

Returns the “default value” for a type.