Skip to content

Commit

Permalink
Fix docstring of set_table_properties
Browse files Browse the repository at this point in the history
  • Loading branch information
astrojuanlu authored and ion-elgreco committed Aug 23, 2024
1 parent fcd62ab commit 6ae2161
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions python/deltalake/table.py
Original file line number Diff line number Diff line change
Expand Up @@ -1904,11 +1904,26 @@ def set_table_properties(
) -> None:
"""
Unset properties from the table.
Args:
properties: properties which set
raise_if_not_exists: set if should raise if not exists.
custom_metadata: custom metadata that will be added to the transaction commit.
Example:
```python
from deltalake import write_deltalake, DeltaTable
import pandas as pd
df = pd.DataFrame(
{"id": ["1", "2", "3"],
"deleted": [False, False, False],
"price": [10., 15., 20.]
})
write_deltalake("tmp", df)
dt = DeltaTable("tmp")
dt.alter.set_table_properties({"delta.enableChangeDataFeed": "true"})
```
"""
self.table._table.set_table_properties(
properties, raise_if_not_exists, custom_metadata
Expand Down

0 comments on commit 6ae2161

Please sign in to comment.