Commit Graph

50 Commits

Author SHA1 Message Date
Avril Aysha 11ab3f6849
docs: improve daft integration docs (#2496)
This PR improves the Daft integration docs to better highlight key Delta
features.
2024-05-20 09:45:31 +00:00
Avril Aysha 497ed209b6 docs: fix typo 2024-05-13 06:32:54 -07:00
Stephen Carman 4dce000f02
feat: cdf reader for delta tables (#2048)
# Description
This PR is the initial work for Change Data Feed (CDF) readers for delta
tables. This PR looks a lot larger than it really is because a physical
test table is checked in with this which will be removed once the loop
is closed on CDF reading/writing.

# Related Issue(s)

# Documentation

https://github.com/delta-io/delta/blob/master/PROTOCOL.md#change-data-files
https://github.com/delta-io/delta/blob/master/PROTOCOL.md#add-cdc-file

---------

Co-authored-by: R. Tyler Croy <rtyler@brokenco.de>
2024-04-30 18:15:39 -07:00
Avril Aysha d49d95ba4b
docs: add Daft integration (#2402)
This adds an integration page for using Delta Lake with Daft.

---------

Co-authored-by: Ion Koutsouris <15728914+ion-elgreco@users.noreply.github.com>
2024-04-13 08:09:39 +02:00
Alessandro Rinaldi fef111c129
docs: document required aws permissions (#2393)
# Description
This documents the required AWS permissions on S3 and DynamoDB to
interact with deltalakes.

# Related Issue(s)
- mentions #1091
2024-04-06 22:05:48 +02:00
LauH1987 f32779dffc Fix for replaceWhere
Fix for Rust example in 'Overwriting part of the table data using a predicate' part of the delta-rs webpage
2024-03-19 06:46:05 -07:00
vladislav doster 6b39cb9247
docs: fix typo in delta-lake-polars.md (#2285)
# Description

Correct the spelling of `without`.

# Related Issue(s)

N/A

# Documentation

N/A
2024-03-13 10:39:44 -04:00
gautham acharya 1e19cf3f20 fix: include .venv in .gitignore 2024-03-08 16:54:38 -08:00
gautham acharya f82cbd3741 Optimize commit v1 2024-03-08 16:54:38 -08:00
Avril Aysha 16fd95ff53
docs: use dagster deltalake polars library (#2263)
use `dagster-deltalake-polars ` instead of `dagster-polars`
2024-03-08 11:28:41 +00:00
Avril Aysha fe36b13616
docs: create Dagster integration page (#2159)
This adds an Integration page to the docs re: Dagster.

---------

Co-authored-by: Matthew Powers <matthewkevinpowers@gmail.com>
2024-03-07 17:32:21 -05:00
Adrian Ehrsam c3d532bfbc feat: merge schema support for the write operation and Python (with Rust engine)
This replaces the old "overwrite_schema" parameter with a
schema_write_mode parameter that basically allows to distinguish between
overwrite/merge/none

Fixes #1386
2024-03-05 07:48:28 -08:00
Adrian Ehrsam 15538b9b42
fix: fix ruff and mypy version and do formatting (#2240)
# Description
As requested by @ion-elgreco in #2229 , we should fix the formatter
versions

# Related Issue(s)
<!---
For example:

- closes #106
--->

# Documentation

<!---
Share links to useful documentation
--->
2024-03-04 10:08:50 +00:00
Avril Aysha 77ddd7cb1c fix formatting typo 2024-02-21 13:50:52 -08:00
Matthew Powers 0449db9c3c
docs: add delta lake best practices (#2147)
Adds a docs page on the Delta Lake best practices.

This is a first pass and I think this should evolve over time.

This is some of the most important content for our users IMO.
2024-02-19 14:38:55 +00:00
Niko b1074077bb
feat: implementation for replaceWhere (#1996)
# Description
First/naive implementation of `replaceWhere` for `write`. Code compiles
and there is a test to verify the outcome. I would appreciate any
feedback on improving the structure/implementation. For example, I
copied the part of code from `delete` operation because there is no way
to call that code in `delete` directly from `write` - should I look into
extracting that code from `delete` to somewhere central?

Seems to also works with partitions columns.

# Related Issue(s)
https://github.com/delta-io/delta-rs/issues/1957

# Documentation
Added a section in docs

---------

Signed-off-by: Nikolay Ulmasov <ulmasov@hotmail.com>
Co-authored-by: Ion Koutsouris <15728914+ion-elgreco@users.noreply.github.com>
2024-01-31 08:09:07 +00:00
Matthew Powers 1b6c830aae
docs: delta lake is great for small data (#2113)
# Description

Add page describing how Delta Lake is great for small data too.

# Related Issue(s)

n/a

# Documentation

This PR introduces a new docs page.
2024-01-28 12:41:30 +01:00
Richard Pelgrim 603a81e89a
docs: add dask page to integration docs (#2122)
Co-authored-by: Ion Koutsouris <15728914+ion-elgreco@users.noreply.github.com>
2024-01-27 11:09:35 +00:00
Matthew Powers 951436ecec docs: delta lake file skipping 2024-01-23 07:19:54 -08:00
Ion Koutsouris 61ca275b57
docs: move dynamo docs into new docs page (#2093)
# Description
Adds the dynamo docs into our new docs, within the python
write_deltalake I am pointing to the guide since it's quite extensive
and only for S3 users.


@rtyler @dispanser
2024-01-21 19:12:25 +01:00
Matthew Powers 5eda27cedb
docs: how delta lake transactions work (#2089)
@nkarpov and I collaborated on this Delta Lake transactions post.

It's meant to give the basics on how transactions work and why they're a
huge advantage of Delta Lakes.

@rtyler is giving a talk on transactions/concurrency soon. We're trying
to set the stage with some foundational content first.

---------

Co-authored-by: Ion Koutsouris <15728914+ion-elgreco@users.noreply.github.com>
2024-01-19 12:50:30 +01:00
Matthew Powers 2ae5be153c docs: updates based on pr feedback 2024-01-18 08:46:28 -08:00
Matthew Powers 595422b695 docs: add page on why to use delta lake 2024-01-18 08:46:28 -08:00
Matthew Powers caf16896c9 docs: add some tabbed code blocks 2024-01-18 08:46:28 -08:00
Stephen Carman d65fc18319
docs: add usage guide for check constraints (#2079)
# Description
Added a usage guide for adding check constraints to tables

# Related Issue(s)
Closes #2063 

# Documentation

I just wrote it
2024-01-16 11:28:44 -05:00
Niko ff0dd79cec
docs: make an overview tab visible in docs (#2080)
# Description
Currently Usage/Overview points as `usage/index.md` and therefore it
does not appear in the left-hand-side menu (it is hidden behind the
`Usage` header of the sub-menu. Renaming the files fixes that

Signed-off-by: Nikolay Ulmasov <ulmasov@hotmail.com>
2024-01-14 20:20:47 -05:00
Ion Koutsouris 4cb754b61a
docs: add alterer (#2014)
Again, forgot some docs, and added missing descriptions
2024-01-02 11:36:19 -05:00
Ion Koutsouris 1f9898acc5
docs: add writer properties to docs (#2002)
# Description
Forgot to add WriterProperties to the docs page and mark a deprecation
in the docs.
2024-01-02 10:43:39 -05:00
Matthew Powers 6da3b3bf81 docs: explain why delta-rs depends on datafusion 2023-12-29 11:31:00 -08:00
Matthew Powers cb20ad782a docs: datafusion integration 2023-12-29 11:31:00 -08:00
Matthew Powers a492058797
docs: add better installation instructions (#1951)
# Description

Adds better installation instructions.

Explains how to install the library with Conda and how to use it with
Jupyter Notebooks.
2023-12-09 00:14:54 +01:00
Matthew Powers e54996ae3b
docs: add polars integration (#1949)
# Description

First pass at documentation for the polars integration.

Co-authored-by: Ion Koutsouris <15728914+ion-elgreco@users.noreply.github.com>
2023-12-07 11:22:50 -05:00
Matthew Powers bca00ae054 docs: start how delta lake works 2023-12-04 22:39:06 -08:00
Ion Koutsouris d441940cdc
docs: add logo, dark mode, boost search (#1936)
- Adds transparent logo (we need a higher quality one), I've pinged
@fvaleye on Slack to check whether he has one.
- Add dark mode toggle
- Boost some search results since it was prioritizing the guides over
the API reference
2023-12-04 13:05:19 +01:00
Ion Koutsouris 9cd3a85497
docs: fix all examples and change overall structure (#1931)
# Description
I have made a bunch of improvements to fix the overall structure due to
example sections not being consistent. I've also enabled some extra
features. Fixed also the issue of some classes/functions not being shown
properly.
2023-12-01 09:16:56 -08:00
Matthew Powers 538be39942
docs: delta lake arrow integration page (#1914)
# Description

Adds a documentation page on the Delta Lake Arrow integration.
2023-11-29 21:08:10 +00:00
Matthew Powers 8ca8d655cf
docs: update docs home page and add pandas integration (#1905)
# Description

Updated the docs home page to include more information about the
project.

Also added a pandas integration page. Lots more integration pages to
come soon hopefully!
2023-11-26 15:42:09 +01:00
Matthew Powers 31767bf79b
docs: on append, overwrite, delete and z-ordering (#1897)
# 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.
2023-11-22 20:23:14 +00:00
Matthew Powers daa700eada Add Rust installation instructions 2023-11-17 16:55:33 -08:00
Matthew Powers 0ef811063a Add docs on small file compaction with optimize 2023-11-17 13:20:01 -08:00
Nikolay Ulmasov 2850c1794d add release actions for docs
Signed-off-by: Nikolay Ulmasov <ulmasov@hotmail.com>
2023-11-06 07:58:00 -08:00
Nikolay Ulmasov cc4bc8f54c add CI for docs
Signed-off-by: Nikolay Ulmasov <ulmasov@hotmail.com>
2023-11-04 08:39:35 -07:00
Nikolay Ulmasov 8f0b2d7764 use official Python API for references 2023-10-30 12:05:32 -07:00
Nikolay Ulmasov cd38107fba enhance docs to enable multi-lingual examples 2023-10-30 12:05:32 -07:00
Niko a67140c6b1
docs: convert docs to use mkdocs (#1731)
# Description
Completed the outstanding tasks in #1708

Also changed theme from readthedocs to mkdocs - both are built-in but
latter looks sleeker

# Related Issue(s)
closes #1708

---------

Co-authored-by: Robert Pack <42610831+roeap@users.noreply.github.com>
Co-authored-by: R. Tyler Croy <rtyler@brokenco.de>
2023-10-23 19:02:02 +00:00
Will Jones 2fccbdb849
Start python api docs 2023-07-26 10:20:02 -07:00
Matthew Powers 433fb6b370 Port docs to mkdocs 2023-07-26 09:43:42 -07:00
Robert Pack 729d18be46
chore: cleanup (#774) 2022-08-31 07:30:29 -07:00
dgcaron 6ea048077b
Update ADLSGen2-HOWTO.md (#560)
* Update ADLSGen2-HOWTO.md

I had a hard time figuring out how to connect to a delta table that is stored in ADLS Gen2 and only found a way by digging into the source code. I would like to save other people the same trouble by adding this to the docs.

* altered prefix for azure
2022-03-07 10:57:51 -08:00
Thomas Vollmer 222837cf8f
Add docs for ADLS Gen2. (#492) 2021-11-11 19:56:40 +00:00