Struct CreateBuilder

pub struct CreateBuilder { /* private fields */ }

Build an operation to create a new DeltaTable

Implementations

impl CreateBuilder

pub fn new() -> Self

Create a new CreateBuilder

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_location(self, location: impl Into<String>) -> Self

Specify the path to the location where table data is stored, which could be a path on distributed storage.

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

Specify the behavior when a table exists at location

pub fn with_comment(self, comment: impl Into<String>) -> Self

Comment to describe the table.

pub fn with_column( self, name: impl Into<String>, data_type: DataType, nullable: bool, metadata: Option<HashMap<String, Value>>, ) -> Self

Specify a column in the table

pub fn with_columns( self, columns: impl IntoIterator<Item = impl Into<StructField>>, ) -> Self

Specify columns to append to schema

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

Specify table partitioning

pub fn with_storage_options( self, storage_options: HashMap<String, String>, ) -> Self

Set options used to initialize storage backend

Options may be passed in the HashMap or set as environment variables.

[crate::table::builder::s3_storage_options] describes the available options for the AWS or S3-compliant backend. If an object store is also passed using with_object_store() these options will be ignored.

pub fn with_configuration( self, configuration: impl IntoIterator<Item = (impl Into<String>, Option<impl Into<String>>)>, ) -> Self

Set configuration on created table

pub fn with_configuration_property( self, key: TableProperty, value: Option<impl Into<String>>, ) -> Self

Specify a table property in the table configuration

pub fn with_metadata( self, metadata: impl IntoIterator<Item = (String, Value)>, ) -> Self

Append custom (application-specific) metadata to the commit.

This might include provenance information such as an id of the user that made the commit or the program that created it.

pub fn with_raise_if_key_not_exists(self, raise_if_key_not_exists: bool) -> Self

Specify whether to raise an error if the table properties in the configuration are not TablePropertys

pub fn with_actions(self, actions: impl IntoIterator<Item = Action>) -> Self

Specify additional actions to be added to the commit.

This method is mainly meant for internal use. Manually adding inconsistent actions to a create operation may have undesired effects - use with caution.

pub fn with_log_store(self, log_store: Arc<dyn LogStore>) -> Self

Provide a LogStore instance, that points at table location

Trait Implementations

impl Clone for CreateBuilder

fn clone(&self) -> CreateBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateBuilder

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

Formats the value using the given formatter.

impl Default for CreateBuilder

fn default() -> Self

Returns the “default value” for a type.

impl IntoFuture for CreateBuilder

type Output = Result<DeltaTable, DeltaTableError>

The output that the future will produce on completion.

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