Skip to content
Pyrula

Delta

Generated from the type stubs and docstrings. Do not edit by hand.

Types

Section titled “Types”

ConcurrentWriteError

Section titled “ConcurrentWriteError”

DeltaError

Section titled “DeltaError”

DeltaTable

Section titled “DeltaTable”

create

Section titled “create”
create(path: str, cls: type, partition_by: Optional[list[str]] = None, storage_options: Any = None, table_properties: Optional[dict[str, str]] = None) -> Any

exists

Section titled “exists”
exists(path: str, storage_options: Any = None) -> bool

merge_keyed

Section titled “merge_keyed”
merge_keyed(path: str, run_id: str, step_id: str, rows: Any, cls: Optional[type] = None, storage_options: Any = None) -> Any

read

Section titled “read”
read(self, cls: type, version: Optional[int] = None, timestamp: Optional[str] = None, columns: Optional[list[str]] = None, filters: Any = None) -> Any

read_arrow

Section titled “read_arrow”
read_arrow(self, version: Optional[int] = None, columns: Optional[list[str]] = None, filters: Any = None) -> Any

scan_batches

Section titled “scan_batches”
scan_batches(self, batch_size: int = 65536, columns: Optional[list[str]] = None, filters: Any = None, version: Optional[int] = None) -> Any

load_cdf

Section titled “load_cdf”
load_cdf(self, starting_version: int, ending_version: Optional[int] = None, columns: Optional[list[str]] = None) -> Any

added_files

Section titled “added_files”
added_files(self, from_version: int, to_version: int) -> list[str]

read_added

Section titled “read_added”
read_added(self, from_version: int, to_version: int, columns: Optional[list[str]] = None, filters: Any = None) -> Any

append

Section titled “append”
append(self, records: Any, cls: Optional[type] = None, schema_mode: str = 'merge') -> Any

write_arrow

Section titled “write_arrow”
write_arrow(path: str, data: Any, mode: str = 'append', commit_metadata: Optional[dict[str, str]] = None, storage_options: Any = None, schema_mode: Optional[str] = None, report: bool = True) -> Any

overwrite

Section titled “overwrite”
overwrite(self, records: Any, cls: Optional[type] = None, partition_by: Optional[list[str]] = None, predicate: Optional[str] = None) -> Any

delete

Section titled “delete”
delete(self, predicate: str) -> Any

update

Section titled “update”
update(self, predicate: str, values: dict) -> Any

merge

Section titled “merge”
merge(self, source: Any, predicate: str, cls: Optional[type] = None, source_alias: str = 'source', target_alias: str = 'target') -> MergeBuilder

schema

Section titled “schema”
schema(self) -> Any

version

Section titled “version”
version(self) -> Any

history

Section titled “history”
history(self, limit: int = 10) -> Any

vacuum

Section titled “vacuum”
vacuum(self, retention_hours: int = 168, dry_run: bool = False, enforce_retention_duration: bool = True) -> Any

optimize

Section titled “optimize”
optimize(self) -> Any

MergeBuilder

Section titled “MergeBuilder”

when_matched_update_all

Section titled “when_matched_update_all”
when_matched_update_all(self) -> MergeBuilder

when_matched_delete

Section titled “when_matched_delete”
when_matched_delete(self, predicate: Optional[str] = None) -> MergeBuilder

when_not_matched_insert_all

Section titled “when_not_matched_insert_all”
when_not_matched_insert_all(self) -> MergeBuilder

execute

Section titled “execute”
execute(self) -> Any

MergeReport

Section titled “MergeReport”

Fields:

  • rows_inserted: int
  • rows_updated: int
  • rows_deleted: int
  • version: int
  • files_added: int
  • files_removed: int

SchemaError

Section titled “SchemaError”

StorageError

Section titled “StorageError”

TableNotFoundError

Section titled “TableNotFoundError”

VersionNotFoundError

Section titled “VersionNotFoundError”

WriteReport

Section titled “WriteReport”

Fields:

  • rows_written: int
  • version: int
  • files_added: int
  • files_removed: int