-
Notifications
You must be signed in to change notification settings - Fork 413
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.
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
docs: on append, overwrite, delete and z-ordering #1897
Conversation
ACTION NEEDED delta-rs follows the Conventional Commits specification for release automation. The PR title and description are used as the merge commit message. Please update your PR title and description to match the specification. |
|
||
```python | ||
df = pd.DataFrame({"num": [8, 9], "letter": ["dd", "ee"]}) | ||
dl.writer.write_deltalake("tmp/some-table", df, mode="append") |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we showcase examples where you import it like as dl.
I think we generally import directly, right?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ion-elgreco - I updated this. Also going to create an issue to discuss this in more detail. Thank you!
You can easily write a DataFrame to a Delta table. | ||
|
||
```python | ||
import deltalake as dl |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think you forgot to remove this import as well
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated.
|
||
```python | ||
import deltalake as dl | ||
from deltalake.writer import write_deltalake |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We expose write_deltalake also on the deltalake module directly. Also in other docs we import directly from there, maybe do it here as well for consistency
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I get this error: cannot import name 'DeltaLake' from 'deltalake'
You sure write_deltalake
is exposed on deltalake
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I had a typo. You're right. Updated.
|
||
This section explains how to Z Order a Delta table. | ||
|
||
Z Ordering colocates similar data in the same files, which allows for more better file skipping and faster queries. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
more
or better
, right? not both
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed, thanks
# Description Adds docs on how to append, overwrite, delete rows, and Z Order Delta tables. Will add much more detailed pages in the future. Just getting the high-level skeleton of the docs developed.
Description
Adds docs on how to append, overwrite, delete rows, and Z Order Delta tables.
Will add much more detailed pages in the future. Just getting the high-level skeleton of the docs developed.