Skip to content

docs: clarify table write API docstrings #3346

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
BharatDeva wants to merge 1 commit into
base: main
Choose a base branch
from
+9 −1
Open

docs: clarify table write API docstrings #3346

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion pyiceberg/table/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1378,7 +1378,7 @@ def append(self, df: pa.Table, snapshot_properties: dict[str, str] = EMPTY_DICT,
Shorthand API for appending a PyArrow table to the table.

Args:
df: The Arrow dataframe that will be appended to overwrite the table
df: The Arrow dataframe that will be appended to the table
snapshot_properties: Custom properties to be added to the snapshot summary
branch: Branch Reference to run the append operation
"""
Expand Down Expand Up @@ -1466,6 +1466,9 @@ def add_files(

Args:
file_paths: The list of full file paths to be added as data files to the table
snapshot_properties: Custom properties to be added to the snapshot summary
check_duplicate_files: Whether to check if the files are already present in the table
branch: Branch Reference to run the add-files operation

Raises:
FileNotFoundError: If the file does not exist.
Expand All @@ -1479,6 +1482,11 @@ def add_files(
)

def update_spec(self, case_sensitive: bool = True) -> UpdateSpec:
"""Create a new UpdateSpec to update the partitioning of the table.

Args:
case_sensitive: Whether column name matching should be case-sensitive.
"""
return UpdateSpec(Transaction(self, autocommit=True), case_sensitive=case_sensitive)

def refs(self) -> dict[str, SnapshotRef]:
Expand Down