pub struct UpdateBuilder { /* private fields */ }
Expand description
Updates records in the Delta Table. See this module’s documentation for more information
Implementations§
Source§impl UpdateBuilder
impl UpdateBuilder
Sourcepub fn new(log_store: LogStoreRef, snapshot: DeltaTableState) -> Self
pub fn new(log_store: LogStoreRef, snapshot: DeltaTableState) -> Self
Create a new [‘UpdateBuilder’]
Sourcepub fn with_predicate<E: Into<Expression>>(self, predicate: E) -> Self
pub fn with_predicate<E: Into<Expression>>(self, predicate: E) -> Self
Which records to update
Sourcepub fn with_update<S: Into<DeltaColumn>, E: Into<Expression>>(
self,
column: S,
expression: E,
) -> Self
pub fn with_update<S: Into<DeltaColumn>, E: Into<Expression>>( self, column: S, expression: E, ) -> Self
Perform an additional update expression during the operaton
Sourcepub fn with_session_state(self, state: SessionState) -> Self
pub fn with_session_state(self, state: SessionState) -> Self
The Datafusion session state to use
Sourcepub fn with_commit_properties(self, commit_properties: CommitProperties) -> Self
pub fn with_commit_properties(self, commit_properties: CommitProperties) -> Self
Additional metadata to be added to commit info
Sourcepub fn with_writer_properties(self, writer_properties: WriterProperties) -> Self
pub fn with_writer_properties(self, writer_properties: WriterProperties) -> Self
Writer properties passed to parquet writer for when fiiles are rewritten
Sourcepub fn with_safe_cast(self, safe_cast: bool) -> Self
pub fn with_safe_cast(self, safe_cast: bool) -> Self
Specify the cast options to use when casting columns that do not match
the table’s schema. When cast_options.safe
is set true then any
failures to cast a datatype will use null instead of returning an error
to the user.
Example (column’s type is int): Input Output 123 -> 123 Test123 -> null
Trait Implementations§
Source§impl IntoFuture for UpdateBuilder
impl IntoFuture for UpdateBuilder
Source§type Output = Result<(DeltaTable, UpdateMetrics), DeltaTableError>
type Output = Result<(DeltaTable, UpdateMetrics), DeltaTableError>
The output that the future will produce on completion.
Source§type IntoFuture = Pin<Box<dyn Future<Output = <UpdateBuilder as IntoFuture>::Output> + Send>>
type IntoFuture = Pin<Box<dyn Future<Output = <UpdateBuilder as IntoFuture>::Output> + Send>>
Which kind of future are we turning this into?
Source§fn into_future(self) -> Self::IntoFuture
fn into_future(self) -> Self::IntoFuture
Creates a future from a value. Read more
Auto Trait Implementations§
impl Freeze for UpdateBuilder
impl !RefUnwindSafe for UpdateBuilder
impl Send for UpdateBuilder
impl Sync for UpdateBuilder
impl Unpin for UpdateBuilder
impl !UnwindSafe for UpdateBuilder
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
Mutably borrows from an owned value. Read more
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>
Converts
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>
Converts
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