Struct ConvertToDeltaBuilder

pub struct ConvertToDeltaBuilder { /* private fields */ }

Build an operation to convert a Parquet table to a DeltaTable in place

Implementations

impl ConvertToDeltaBuilder

pub fn new() -> Self

Create a new ConvertToDeltaBuilder

pub fn with_log_store(self, log_store: Arc<dyn LogStore>) -> Self

Provide a LogStore instance, that points at table location

pub fn with_location(self, location: impl Into<String>) -> Self

Specify the path to the location where table data is stored, which could be a path on distributed storage.

If an object store is also passed using with_log_store(), this path will be ignored.

pub fn with_storage_options( self, storage_options: HashMap<String, String>, ) -> Self

Set options used to initialize storage backend

Options may be passed in the HashMap or set as environment variables.

[crate::table::builder::s3_storage_options] describes the available options for the AWS or S3-compliant backend. If an object store is also passed using with_log_store(), these options will be ignored.

pub fn with_partition_schema( self, partition_schema: impl IntoIterator<Item = StructField>, ) -> Self

Specify the partition schema of the Parquet table

pub fn with_partition_strategy(self, strategy: PartitionStrategy) -> Self

Specify the partition strategy of the Parquet table Currently only hive-partitioning is supproted for Parquet paths

pub fn with_save_mode(self, save_mode: SaveMode) -> Self

Specify the behavior when a table exists at location

pub fn with_table_name(self, name: impl Into<String>) -> Self

Specify the table name. Optionally qualified with a database name [database_name.] table_name.

pub fn with_comment(self, comment: impl Into<String>) -> Self

Comment to describe the table.

pub fn with_configuration( self, configuration: impl IntoIterator<Item = (impl Into<String>, Option<impl Into<String>>)>, ) -> Self

Set configuration on created table

pub fn with_configuration_property( self, key: TableProperty, value: Option<impl Into<String>>, ) -> Self

Specify a table property in the table configuration

pub fn with_metadata(self, metadata: Map<String, Value>) -> Self

Append custom (application-specific) metadata to the commit.

This might include provenance information such as an id of the user that made the commit or the program that created it.

Trait Implementations

impl Default for ConvertToDeltaBuilder

fn default() -> Self

Returns the “default value” for a type.

impl IntoFuture for ConvertToDeltaBuilder

type Output = Result<DeltaTable, DeltaTableError>

The output that the future will produce on completion.

type IntoFuture = Pin<Box<dyn Future<Output = <ConvertToDeltaBuilder as IntoFuture>::Output> + Send>>

Which kind of future are we turning this into?

fn into_future(self) -> Self::IntoFuture

Creates a future from a value.