site_name: polars-redis
site_description: A Polars IO plugin for Redis
site_url: https://joshrotenberg.github.io/polars-redis
repo_url: https://github.com/joshrotenberg/polars-redis
repo_name: joshrotenberg/polars-redis
theme:
name: material
palette:
- scheme: default
primary: deep purple
accent: amber
toggle:
icon: material/brightness-7
name: Switch to dark mode
- scheme: slate
primary: deep purple
accent: amber
toggle:
icon: material/brightness-4
name: Switch to light mode
features:
- navigation.instant
- navigation.tracking
- navigation.sections
- navigation.expand
- navigation.top
- search.suggest
- search.highlight
- content.code.copy
- content.tabs.link
plugins:
- search
extra:
slides_url: slides/index.html
hooks:
- docs/hooks.py
markdown_extensions:
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets:
base_path: ["."]
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- admonition
- pymdownx.details
- attr_list
- md_in_html
- tables
- toc:
permalink: true
nav:
- Home: index.md
- Getting Started:
- Installation: getting-started/installation.md
- Quick Start: getting-started/quickstart.md
- User Guide:
- Scanning Data: guide/scanning.md
- RediSearch: guide/redisearch.md
- Writing Data: guide/writing.md
- DataFrame Caching: guide/caching.md
- Pub/Sub Streaming: guide/pubsub.md
- Streams Consumption: guide/streams.md
- Schema Inference: guide/schema-inference.md
- Configuration: guide/configuration.md
- Performance: guide/performance.md
- Cluster Support: guide/cluster.md
- Use Cases: guide/use-cases.md
- Ephemeral Workbench: guide/ephemeral-workbench.md
- Migration Guide: guide/migration.md
- API Reference:
- Python API: api/python.md
- Rust API: api/rust.md
- Examples:
- Python Examples: examples/python.md
- Rust Examples: examples/rust.md
- Advanced Queries: examples/advanced-queries.md
- Presentation: slides.md
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/joshrotenberg/polars-redis