Struct DeltaTableBuilder

pub struct DeltaTableBuilder { /* private fields */ }

builder for configuring a delta table load.

Implementations

impl DeltaTableBuilder

pub fn from_uri(table_uri: impl AsRef<str>) -> Self

Creates DeltaTableBuilder from table uri

Can panic on an invalid URI

let builder = DeltaTableBuilder::from_uri("../test/tests/data/delta-0.8.0");
assert!(true);

pub fn from_valid_uri(table_uri: impl AsRef<str>) -> DeltaResult<Self>

Creates DeltaTableBuilder from verified table uri.

let builder = DeltaTableBuilder::from_valid_uri("memory:///");
assert!(builder.is_ok(), "Builder failed with {builder:?}");

pub fn without_tombstones(self) -> Self

Sets require_tombstones=false to the builder

pub fn without_files(self) -> Self

Sets require_files=false to the builder

pub fn with_version(self, version: i64) -> Self

Sets version to the builder

pub fn with_log_buffer_size(self, log_buffer_size: usize) -> DeltaResult<Self>

Sets log_buffer_size to the builder

pub fn with_datestring(self, date_string: impl AsRef<str>) -> DeltaResult<Self>

specify the timestamp given as ISO-8601/RFC-3339 timestamp

pub fn with_timestamp(self, timestamp: DateTime<Utc>) -> Self

specify a timestamp

pub fn with_storage_backend( self, storage: Arc<DynObjectStore>, location: Url, ) -> Self

Set the storage backend.

If a backend is not provided then it is derived from table_uri.

Arguments

• storage - A shared reference to an ObjectStore with “/” pointing at delta table root (i.e. where _delta_log is located).
• location - A url corresponding to the storagle location of storage.

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. See documentation of underlying object store implementation for details. Trailing slash will be trimmed in the option’s value to avoid failures. Trimming will only be done if one or more of below conditions are met:

• key ends with _URL (e.g., ENDPOINT_URL, S3_URL, JDBC_URL, etc.)

• value starts with http://`` or https://(e.g.,http://localhost:8000/`)

• Azure options

• S3 options

• Google options

pub fn with_allow_http(self, allow_http: bool) -> Self

Allows unsecure connections via http.

This setting is most useful for testing / development when connecting to emulated services.

pub fn with_io_runtime(self, io_runtime: IORuntime) -> Self

Provide a custom runtime handle or runtime config

pub fn storage_options(&self) -> StorageOptions

Storage options for configuring backend object store

pub fn build_storage(&self) -> DeltaResult<LogStoreRef>

Build a delta storage backend for the given config

pub fn build(self) -> DeltaResult<DeltaTable>

Build the DeltaTable from specified options.

This will not load the log, i.e. the table is not initialized. To get an initialized table use the load function

pub async fn load(self) -> DeltaResult<DeltaTable>

Build the DeltaTable and load its state

Trait Implementations

impl Debug for DeltaTableBuilder

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

Formats the value using the given formatter.