Struct deltalake::operations::write::WriteBuilder
source · pub struct WriteBuilder { /* private fields */ }
Expand description
Write data into a DeltaTable
Implementations§
source§impl WriteBuilder
impl WriteBuilder
sourcepub fn new(
log_store: Arc<dyn LogStore>,
snapshot: Option<DeltaTableState>
) -> WriteBuilder
pub fn new( log_store: Arc<dyn LogStore>, snapshot: Option<DeltaTableState> ) -> WriteBuilder
Create a new WriteBuilder
sourcepub fn with_save_mode(self, save_mode: SaveMode) -> WriteBuilder
pub fn with_save_mode(self, save_mode: SaveMode) -> WriteBuilder
Specify the behavior when a table exists at location
sourcepub fn with_schema_mode(self, schema_mode: SchemaMode) -> WriteBuilder
pub fn with_schema_mode(self, schema_mode: SchemaMode) -> WriteBuilder
Add Schema Write Mode
sourcepub fn with_replace_where(
self,
predicate: impl Into<Expression>
) -> WriteBuilder
pub fn with_replace_where( self, predicate: impl Into<Expression> ) -> WriteBuilder
When using Overwrite
mode, replace data that matches a predicate
sourcepub fn with_partition_columns(
self,
partition_columns: impl IntoIterator<Item = impl Into<String>>
) -> WriteBuilder
pub fn with_partition_columns( self, partition_columns: impl IntoIterator<Item = impl Into<String>> ) -> WriteBuilder
(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.
sourcepub fn with_input_execution_plan(
self,
plan: Arc<dyn ExecutionPlan>
) -> WriteBuilder
pub fn with_input_execution_plan( self, plan: Arc<dyn ExecutionPlan> ) -> WriteBuilder
Execution plan that produces the data to be written to the delta table
sourcepub fn with_input_session_state(self, state: SessionState) -> WriteBuilder
pub fn with_input_session_state(self, state: SessionState) -> WriteBuilder
A session state accompanying a given input plan, containing e.g. registered object stores
sourcepub fn with_input_batches(
self,
batches: impl IntoIterator<Item = RecordBatch>
) -> WriteBuilder
pub fn with_input_batches( self, batches: impl IntoIterator<Item = RecordBatch> ) -> WriteBuilder
Execution plan that produces the data to be written to the delta table
sourcepub fn with_target_file_size(self, target_file_size: usize) -> WriteBuilder
pub fn with_target_file_size(self, target_file_size: usize) -> WriteBuilder
Specify the target file size for data files written to the delta table.
sourcepub fn with_write_batch_size(self, write_batch_size: usize) -> WriteBuilder
pub fn with_write_batch_size(self, write_batch_size: usize) -> WriteBuilder
Specify the target batch size for row groups written to parquet files.
sourcepub fn with_cast_safety(self, safe: bool) -> WriteBuilder
pub fn with_cast_safety(self, safe: bool) -> WriteBuilder
Specify the safety of the casting operation how to handle cast failures, either return NULL (safe=true) or return ERR (safe=false)
sourcepub fn with_writer_properties(
self,
writer_properties: WriterProperties
) -> WriteBuilder
pub fn with_writer_properties( self, writer_properties: WriterProperties ) -> WriteBuilder
Specify the writer properties to use when writing a parquet file
sourcepub fn with_commit_properties(
self,
commit_properties: CommitProperties
) -> WriteBuilder
pub fn with_commit_properties( self, commit_properties: CommitProperties ) -> WriteBuilder
Additional metadata to be added to commit info
sourcepub fn with_table_name(self, name: impl Into<String>) -> WriteBuilder
pub fn with_table_name(self, name: impl Into<String>) -> WriteBuilder
Specify the table name. Optionally qualified with a database name [database_name.] table_name.
sourcepub fn with_description(self, description: impl Into<String>) -> WriteBuilder
pub fn with_description(self, description: impl Into<String>) -> WriteBuilder
Comment to describe the table.
sourcepub fn with_configuration(
self,
configuration: impl IntoIterator<Item = (impl Into<String>, Option<impl Into<String>>)>
) -> WriteBuilder
pub fn with_configuration( self, configuration: impl IntoIterator<Item = (impl Into<String>, Option<impl Into<String>>)> ) -> WriteBuilder
Set configuration on created table
Trait Implementations§
source§impl IntoFuture for WriteBuilder
impl IntoFuture for WriteBuilder
§type Output = Result<DeltaTable, DeltaTableError>
type Output = Result<DeltaTable, DeltaTableError>
§type IntoFuture = Pin<Box<dyn Future<Output = <WriteBuilder as IntoFuture>::Output> + Send>>
type IntoFuture = Pin<Box<dyn Future<Output = <WriteBuilder as IntoFuture>::Output> + Send>>
source§fn into_future(self) -> <WriteBuilder as IntoFuture>::IntoFuture
fn into_future(self) -> <WriteBuilder as IntoFuture>::IntoFuture
Auto Trait Implementations§
impl Freeze for WriteBuilder
impl !RefUnwindSafe for WriteBuilder
impl Send for WriteBuilder
impl Sync for WriteBuilder
impl Unpin for WriteBuilder
impl !UnwindSafe for WriteBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more