site_name: Delta Arrow Reader
site_url: https://mag1cfrog.github.io/delta-arrow-reader/
site_description: Read Delta Lake tables as Apache Arrow streams or DataFusion tables.
repo_name: mag1cfrog/delta-arrow-reader
repo_url: https://github.com/mag1cfrog/delta-arrow-reader
docs_dir: public
site_dir: .site
theme:
name: material
variant: modern
features:
- navigation.tabs
- navigation.sections
- content.code.copy
- search.suggest
- search.highlight
plugins:
- search
- mkdocstrings:
handlers:
python:
paths: [python_api]
options:
allow_inspection: false
show_source: false
separate_signature: true
line_length: 80
show_signature_annotations: true
show_if_no_docstring: true
show_root_heading: true
show_root_full_path: false
merge_init_into_class: true
group_by_category: false
members_order: source
markdown_extensions:
- admonition
- md_in_html
- pymdownx.details
- pymdownx.superfences
- pymdownx.inlinehilite
- pymdownx.highlight:
anchor_linenums: false
extend_pygments_lang:
- name: no_run
lang: rust
- name: ignore
lang: rust
nav:
- Start here:
- Overview: index.md
- Installation: installation.md
- Python quickstart: python.md
- Command-line quickstart: cli-quickstart.md
- Rust quickstart: streaming-reader.md
- DataFusion in Rust: datafusion.md
- Configuration: configuration.md
- How it works:
- How a read works: architecture.md
- Reusing a loaded table: delta-metadata-lifecycle.md
- Scan planning: scan-planning.md
- Read scheduling: read-scheduling.md
- Partial-page reads: partial-page-reads.md
- Performance:
- Overview: benchmarks.md
- Selective reads on wide tables: benchmarks/selective-read-results.md
- Repeated queries: benchmarks/eager-metadata.md
- Decoding filter columns: benchmarks/row-filter.md
- Skipping pages: benchmarks/page-index.md
- Combining read requests: benchmarks/range-planning.md
- Reference:
- Command-line reference: cli.md
- Execution options: reference/execution-options.md
- Scan metrics: reference/metrics.md
- Rust API: https://docs.rs/delta-arrow-reader
- Python API:
- Overview: python-api/index.md
- DeltaTable: python-api/table.md
- Session: python-api/session.md
- ScanExecutionOptions: python-api/options.md
- Streams and errors: python-api/streams-and-errors.md