Skip to main content

TableOptimizerRunBuilder

Struct TableOptimizerRunBuilder 

Source
#[non_exhaustive]
pub struct TableOptimizerRunBuilder { /* private fields */ }
Expand description

A builder for TableOptimizerRun.

Implementations§

Source§

impl TableOptimizerRunBuilder

Source

pub fn event_type(self, input: TableOptimizerEventType) -> Self

An event type representing the status of the table optimizer run.

Source

pub fn set_event_type(self, input: Option<TableOptimizerEventType>) -> Self

An event type representing the status of the table optimizer run.

Source

pub fn get_event_type(&self) -> &Option<TableOptimizerEventType>

An event type representing the status of the table optimizer run.

Source

pub fn start_timestamp(self, input: DateTime) -> Self

Represents the epoch timestamp at which the compaction job was started within Lake Formation.

Source

pub fn set_start_timestamp(self, input: Option<DateTime>) -> Self

Represents the epoch timestamp at which the compaction job was started within Lake Formation.

Source

pub fn get_start_timestamp(&self) -> &Option<DateTime>

Represents the epoch timestamp at which the compaction job was started within Lake Formation.

Source

pub fn end_timestamp(self, input: DateTime) -> Self

Represents the epoch timestamp at which the compaction job ended.

Source

pub fn set_end_timestamp(self, input: Option<DateTime>) -> Self

Represents the epoch timestamp at which the compaction job ended.

Source

pub fn get_end_timestamp(&self) -> &Option<DateTime>

Represents the epoch timestamp at which the compaction job ended.

Source

pub fn metrics(self, input: RunMetrics) -> Self

👎Deprecated:

Metrics has been replaced by optimizer type specific metrics such as IcebergCompactionMetrics

A RunMetrics object containing metrics for the optimizer run.

This member is deprecated. See the individual metric members for compaction, retention, and orphan file deletion.

Source

pub fn set_metrics(self, input: Option<RunMetrics>) -> Self

👎Deprecated:

Metrics has been replaced by optimizer type specific metrics such as IcebergCompactionMetrics

A RunMetrics object containing metrics for the optimizer run.

This member is deprecated. See the individual metric members for compaction, retention, and orphan file deletion.

Source

pub fn get_metrics(&self) -> &Option<RunMetrics>

👎Deprecated:

Metrics has been replaced by optimizer type specific metrics such as IcebergCompactionMetrics

A RunMetrics object containing metrics for the optimizer run.

This member is deprecated. See the individual metric members for compaction, retention, and orphan file deletion.

Source

pub fn error(self, input: impl Into<String>) -> Self

An error that occured during the optimizer run.

Source

pub fn set_error(self, input: Option<String>) -> Self

An error that occured during the optimizer run.

Source

pub fn get_error(&self) -> &Option<String>

An error that occured during the optimizer run.

Source

pub fn compaction_metrics(self, input: CompactionMetrics) -> Self

A CompactionMetrics object containing metrics for the optimizer run.

Source

pub fn set_compaction_metrics(self, input: Option<CompactionMetrics>) -> Self

A CompactionMetrics object containing metrics for the optimizer run.

Source

pub fn get_compaction_metrics(&self) -> &Option<CompactionMetrics>

A CompactionMetrics object containing metrics for the optimizer run.

Source

pub fn compaction_strategy(self, input: CompactionStrategy) -> Self

The strategy used for the compaction run. Indicates which algorithm was applied to determine how files were selected and combined during the compaction process. Valid values are:

  • binpack: Combines small files into larger files, typically targeting sizes over 100MB, while applying any pending deletes. This is the recommended compaction strategy for most use cases.

  • sort: Organizes data based on specified columns which are sorted hierarchically during compaction, improving query performance for filtered operations. This strategy is recommended when your queries frequently filter on specific columns. To use this strategy, you must first define a sort order in your Iceberg table properties using the sort_order table property.

  • z-order: Optimizes data organization by blending multiple attributes into a single scalar value that can be used for sorting, allowing efficient querying across multiple dimensions. This strategy is recommended when you need to query data across multiple dimensions simultaneously. To use this strategy, you must first define a sort order in your Iceberg table properties using the sort_order table property.

Source

pub fn set_compaction_strategy(self, input: Option<CompactionStrategy>) -> Self

The strategy used for the compaction run. Indicates which algorithm was applied to determine how files were selected and combined during the compaction process. Valid values are:

  • binpack: Combines small files into larger files, typically targeting sizes over 100MB, while applying any pending deletes. This is the recommended compaction strategy for most use cases.

  • sort: Organizes data based on specified columns which are sorted hierarchically during compaction, improving query performance for filtered operations. This strategy is recommended when your queries frequently filter on specific columns. To use this strategy, you must first define a sort order in your Iceberg table properties using the sort_order table property.

  • z-order: Optimizes data organization by blending multiple attributes into a single scalar value that can be used for sorting, allowing efficient querying across multiple dimensions. This strategy is recommended when you need to query data across multiple dimensions simultaneously. To use this strategy, you must first define a sort order in your Iceberg table properties using the sort_order table property.

Source

pub fn get_compaction_strategy(&self) -> &Option<CompactionStrategy>

The strategy used for the compaction run. Indicates which algorithm was applied to determine how files were selected and combined during the compaction process. Valid values are:

  • binpack: Combines small files into larger files, typically targeting sizes over 100MB, while applying any pending deletes. This is the recommended compaction strategy for most use cases.

  • sort: Organizes data based on specified columns which are sorted hierarchically during compaction, improving query performance for filtered operations. This strategy is recommended when your queries frequently filter on specific columns. To use this strategy, you must first define a sort order in your Iceberg table properties using the sort_order table property.

  • z-order: Optimizes data organization by blending multiple attributes into a single scalar value that can be used for sorting, allowing efficient querying across multiple dimensions. This strategy is recommended when you need to query data across multiple dimensions simultaneously. To use this strategy, you must first define a sort order in your Iceberg table properties using the sort_order table property.

Source

pub fn retention_metrics(self, input: RetentionMetrics) -> Self

A RetentionMetrics object containing metrics for the optimizer run.

Source

pub fn set_retention_metrics(self, input: Option<RetentionMetrics>) -> Self

A RetentionMetrics object containing metrics for the optimizer run.

Source

pub fn get_retention_metrics(&self) -> &Option<RetentionMetrics>

A RetentionMetrics object containing metrics for the optimizer run.

Source

pub fn orphan_file_deletion_metrics( self, input: OrphanFileDeletionMetrics, ) -> Self

An OrphanFileDeletionMetrics object containing metrics for the optimizer run.

Source

pub fn set_orphan_file_deletion_metrics( self, input: Option<OrphanFileDeletionMetrics>, ) -> Self

An OrphanFileDeletionMetrics object containing metrics for the optimizer run.

Source

pub fn get_orphan_file_deletion_metrics( &self, ) -> &Option<OrphanFileDeletionMetrics>

An OrphanFileDeletionMetrics object containing metrics for the optimizer run.

Source

pub fn build(self) -> TableOptimizerRun

Consumes the builder and constructs a TableOptimizerRun.

Trait Implementations§

Source§

impl Clone for TableOptimizerRunBuilder

Source§

fn clone(&self) -> TableOptimizerRunBuilder

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TableOptimizerRunBuilder

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for TableOptimizerRunBuilder

Source§

fn default() -> TableOptimizerRunBuilder

Returns the “default value” for a type. Read more
Source§

impl PartialEq for TableOptimizerRunBuilder

Source§

fn eq(&self, other: &TableOptimizerRunBuilder) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for TableOptimizerRunBuilder

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

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
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more