Struct deltalake::DeltaOps

pub struct DeltaOps(pub DeltaTable);

The deltalake crate is currently just a meta-package shim for deltalake-core High level interface for executing commands against a DeltaTable

Tuple Fields

0: DeltaTable

Implementations

impl DeltaOps

pub async fn try_from_uri( uri: impl AsRef<str> ) -> Result<DeltaOps, DeltaTableError>

Create a new DeltaOps instance, operating on DeltaTable at given uri.

use deltalake_core::DeltaOps;

async {
    let ops = DeltaOps::try_from_uri("memory://").await.unwrap();
};

pub async fn try_from_uri_with_storage_options( uri: impl AsRef<str>, storage_options: HashMap<String, String> ) -> Result<DeltaOps, DeltaTableError>

try from uri with storage options

pub fn new_in_memory() -> DeltaOps

Create a new DeltaOps instance, backed by an un-initialized in memory table

Using this will not persist any changes beyond the lifetime of the table object. The main purpose of in-memory tables is for use in testing.

use deltalake_core::DeltaOps;

let ops = DeltaOps::new_in_memory();

pub fn create(self) -> CreateBuilder

Create a new Delta table

use deltalake_core::DeltaOps;

async {
    let ops = DeltaOps::try_from_uri("memory://").await.unwrap();
    let table = ops.create().with_table_name("my_table").await.unwrap();
    assert_eq!(table.version(), 0);
};

pub fn load(self) -> LoadBuilder

Load data from a DeltaTable

pub fn load_cdf(self) -> CdfLoadBuilder

Load a table with CDF Enabled

pub fn write( self, batches: impl IntoIterator<Item = RecordBatch> ) -> WriteBuilder

Write data to Delta table

pub fn vacuum(self) -> VacuumBuilder

Vacuum stale files from delta table

pub fn filesystem_check(self) -> FileSystemCheckBuilder

Audit active files with files present on the filesystem

pub fn optimize<'a>(self) -> OptimizeBuilder<'a>

Audit active files with files present on the filesystem

pub fn delete(self) -> DeleteBuilder

Delete data from Delta table

pub fn update(self) -> UpdateBuilder

Update data from Delta table

pub fn restore(self) -> RestoreBuilder

Restore delta table to a specified version or datetime

pub fn merge<E>(self, source: DataFrame, predicate: E) -> MergeBuilder

where E: Into<Expression>,

Update data from Delta table

pub fn add_constraint(self) -> ConstraintBuilder

Add a check constraint to a table

pub fn drop_constraints(self) -> DropConstraintBuilder

Drops constraints from a table

Trait Implementations

impl AsRef<DeltaTable> for DeltaOps

fn as_ref(&self) -> &DeltaTable

Converts this type into a shared reference of the (usually inferred) input type.

impl From<DeltaOps> for DeltaTable

fn from(ops: DeltaOps) -> DeltaTable

Converts to this type from the input type.

impl From<DeltaTable> for DeltaOps

fn from(table: DeltaTable) -> DeltaOps

Converts to this type from the input type.