Skip to content

Commit

Permalink
Merge branch 'main' into meta-usage
Browse files Browse the repository at this point in the history
  • Loading branch information
roeap authored Dec 4, 2023
2 parents 2a3e023 + d441940 commit e730b78
Show file tree
Hide file tree
Showing 12 changed files with 85 additions and 4 deletions.
8 changes: 7 additions & 1 deletion docs/api/catalog.md
Original file line number Diff line number Diff line change
@@ -1 +1,7 @@
::: deltalake.data_catalog.DataCatalog
---
search:
boost: 2
---


::: deltalake.data_catalog.DataCatalog
6 changes: 6 additions & 0 deletions docs/api/delta_table/delta_table_merger.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
search:
boost: 2
---


# TableMerger

::: deltalake.table.TableMerger
Expand Down
6 changes: 6 additions & 0 deletions docs/api/delta_table/delta_table_optimizer.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
search:
boost: 10
---


# TableOptimizer

::: deltalake.table.TableOptimizer
Expand Down
5 changes: 5 additions & 0 deletions docs/api/delta_table/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
boost: 2
---

# DeltaTable

::: deltalake.DeltaTable
Expand Down
6 changes: 6 additions & 0 deletions docs/api/delta_table/metadata.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
search:
boost: 2
---


# Metadata

::: deltalake.Metadata
Expand Down
9 changes: 8 additions & 1 deletion docs/api/delta_writer.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,14 @@
---
search:
boost: 10
---

# Writer
## Write to Delta Tables

::: deltalake.write_deltalake

## Convert to Delta Tables
::: deltalake.convert_to_deltalake
::: deltalake.convert_to_deltalake


6 changes: 6 additions & 0 deletions docs/api/exceptions.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
search:
boost: 2
---


# Exceptions

::: deltalake.exceptions.DeltaError
Expand Down
6 changes: 6 additions & 0 deletions docs/api/schema.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
search:
boost: 2
---


## Schema and field
Schemas, fields, and data types are provided in the ``deltalake.schema`` submodule.

Expand Down
6 changes: 6 additions & 0 deletions docs/api/storage.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
search:
boost: 2
---


# Storage

The delta filesystem handler for the pyarrow engine writer.
Expand Down
1 change: 1 addition & 0 deletions docs/delta-rust-no-whitespace.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions docs/usage/writing-delta-tables.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ The `data` parameter will accept a Pandas DataFrame, a PyArrow Table, or
an iterator of PyArrow Record Batches.

``` python
>>> from deltalake.writer import write_deltalake
>>> from deltalake import write_deltalake
>>> df = pd.DataFrame({'x': [1, 2, 3]})
>>> write_deltalake('path/to/table', df)
```
Expand Down Expand Up @@ -34,7 +34,7 @@ done on one partition at a time. All of the input data must belong to
that partition or else the method will raise an error.

``` python
>>> from deltalake.writer import write_deltalake
>>> from deltalake import write_deltalake
>>> df = pd.DataFrame({'x': [1, 2, 3], 'y': ['a', 'a', 'b']})
>>> write_deltalake('path/to/table', df, partition_by=['y'])

Expand Down
26 changes: 26 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,32 @@ repo_name: delta-io/delta-rs

theme:
name: material
logo: delta-rust-no-whitespace.svg
favicon: delta-rust-no-whitespace.svg

palette:
# Palette toggle for automatic mode
- media: "(prefers-color-scheme)"
primary: indigo
toggle:
icon: material/brightness-auto
name: Switch to light mode

# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: indigo
toggle:
icon: material/brightness-7
name: Switch to dark mode

# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: indigo
toggle:
icon: material/brightness-4
name: Switch to system preference
locale: en
navigation_depth: 3
features:
Expand Down

0 comments on commit e730b78

Please sign in to comment.