Skip to content

Commit

Permalink
docs: add alterer (#2014)
Browse files Browse the repository at this point in the history
Again, forgot some docs, and added missing descriptions
  • Loading branch information
ion-elgreco authored Jan 2, 2024
1 parent 1f9898a commit 4cb754b
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 1 deletion.
11 changes: 11 additions & 0 deletions docs/api/delta_table/delta_table_alterer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
search:
boost: 10
---


# TableAlterer

::: deltalake.table.TableAlterer
options:
show_root_heading: true
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ nav:
- api/delta_table/metadata.md
- api/delta_table/delta_table_merger.md
- api/delta_table/delta_table_optimizer.md
- api/delta_table/delta_table_alterer.md
- api/schema.md
- api/storage.md
- api/catalog.md
Expand Down
11 changes: 10 additions & 1 deletion python/deltalake/table.py
Original file line number Diff line number Diff line change
Expand Up @@ -785,13 +785,22 @@ def update(
def optimize(
self,
) -> "TableOptimizer":
"""Namespace for all table optimize related methods.
Returns:
TableOptimizer: TableOptimizer Object
"""
return TableOptimizer(self)

@property
def alter(
self,
) -> "TableAlterer":
"""Namespace for all table alter related methods"""
"""Namespace for all table alter related methods.
Returns:
TableAlterer: TableAlterer Object
"""
return TableAlterer(self)

def merge(
Expand Down

0 comments on commit 4cb754b

Please sign in to comment.