Struct WriteBuilder

pub struct WriteBuilder { /* private fields */ }

Write data into a DeltaTable

Implementations

impl WriteBuilder

pub fn new(log_store: LogStoreRef, snapshot: Option<DeltaTableState>) -> Self

Create a new WriteBuilder

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

Specify the behavior when a table exists at location

pub fn with_schema_mode(self, schema_mode: SchemaMode) -> Self

Add Schema Write Mode

pub fn with_replace_where(self, predicate: impl Into<Expression>) -> Self

When using Overwrite mode, replace data that matches a predicate

pub fn with_partition_columns( self, partition_columns: impl IntoIterator<Item = impl Into<String>>, ) -> Self

(Optional) Specify table partitioning. If specified, the partitioning is validated, if the table already exists. In case a new table is created, the partitioning is applied.

pub fn with_input_execution_plan(self, plan: Arc<dyn ExecutionPlan>) -> Self

Execution plan that produces the data to be written to the delta table

pub fn with_input_session_state(self, state: SessionState) -> Self

A session state accompanying a given input plan, containing e.g. registered object stores

pub fn with_input_batches( self, batches: impl IntoIterator<Item = RecordBatch>, ) -> Self

Execution plan that produces the data to be written to the delta table

pub fn with_target_file_size(self, target_file_size: usize) -> Self

Specify the target file size for data files written to the delta table.

pub fn with_write_batch_size(self, write_batch_size: usize) -> Self

Specify the target batch size for row groups written to parquet files.

pub fn with_cast_safety(self, safe: bool) -> Self

Specify the safety of the casting operation how to handle cast failures, either return NULL (safe=true) or return ERR (safe=false)

pub fn with_writer_properties(self, writer_properties: WriterProperties) -> Self

Specify the writer properties to use when writing a parquet file

pub fn with_commit_properties(self, commit_properties: CommitProperties) -> Self

Additional metadata to be added to commit info

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_description(self, description: 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

Trait Implementations

impl IntoFuture for WriteBuilder

type Output = Result<DeltaTable, DeltaTableError>

The output that the future will produce on completion.

type IntoFuture = Pin<Box<dyn Future<Output = <WriteBuilder 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.