Struct iceberg_rust::view::view_builder::ViewBuilder

source ·

pub struct ViewBuilder { /* private fields */ }

Expand description

Builder pattern to create a view

Implementations§

source §

impl ViewBuilder

source

pub fn new( sql: impl ToString, identifier: impl ToString, schema: Schema, catalog: Arc<dyn Catalog> ) -> Result<Self, Error>

Creates a new [TableBuilder] to create a Metastore view with some default metadata entries already set.

source

pub async fn build(self) -> Result<View, Error>

Building a table writes the metadata file and commits the table to either the metastore or the filesystem

Methods from Deref<Target = ViewMetadataBuilder>§

source

pub fn view_uuid(&mut self, value: Uuid) -> &mut GeneralViewMetadataBuilder<T>

A UUID that identifies the view, generated when the view is created. Implementations must throw an exception if a view’s UUID does not match the expected UUID after refreshing metadata

source

pub fn format_version( &mut self, value: FormatVersion ) -> &mut GeneralViewMetadataBuilder<T>

An integer version number for the view format; must be 1

source

pub fn location<VALUE>( &mut self, value: VALUE ) -> &mut GeneralViewMetadataBuilder<T>
where VALUE: Into<String>,

The view’s base location. This is used to determine where to store manifest files and view metadata files.

source

pub fn current_version_id( &mut self, value: i64 ) -> &mut GeneralViewMetadataBuilder<T>

Current version of the view. Set to ‘1’ when the view is first created.

source

pub fn versions( &mut self, value: HashMap<i64, Version> ) -> &mut GeneralViewMetadataBuilder<T>

An array of structs describing the last known versions of the view. Controlled by the table property: “version.history.num-entries”. See section Versions.

source

pub fn with_version<VALUE>( &mut self, item: VALUE ) -> &mut GeneralViewMetadataBuilder<T>
where HashMap<i64, Version>: Default + Extend<VALUE>,

An array of structs describing the last known versions of the view. Controlled by the table property: “version.history.num-entries”. See section Versions.

source

pub fn version_log( &mut self, value: Vec<VersionLogStruct> ) -> &mut GeneralViewMetadataBuilder<T>

A list of timestamp and version ID pairs that encodes changes to the current version for the view. Each time the current-version-id is changed, a new entry should be added with the last-updated-ms and the new current-version-id.

source

pub fn schemas( &mut self, value: HashMap<i32, Schema> ) -> &mut GeneralViewMetadataBuilder<T>

A list of schemas, the same as the ‘schemas’ field from Iceberg table spec.

source

pub fn with_schema<VALUE>( &mut self, item: VALUE ) -> &mut GeneralViewMetadataBuilder<T>
where HashMap<i32, Schema>: Default + Extend<VALUE>,

A list of schemas, the same as the ‘schemas’ field from Iceberg table spec.

source

pub fn properties( &mut self, value: ViewProperties<T> ) -> &mut GeneralViewMetadataBuilder<T>

A string to string map of view properties. This is used for metadata such as “comment” and for settings that affect view maintenance. This is not intended to be used for arbitrary metadata.

source