a3b662f30b
* docs: explain new physical plan construction There is no code yet, but this is the rough plan. Ref #6098. * docs: clarify wording Co-authored-by: Andrew Lamb <alamb@influxdata.com> * docs: typos Co-authored-by: Andrew Lamb <alamb@influxdata.com> * docs: add links * docs: extend reasoning --------- Co-authored-by: Andrew Lamb <alamb@influxdata.com> |
||
|---|---|---|
| .. | ||
| images | ||
| README.md | ||
| cli.md | ||
| compactor.md | ||
| dedup_and_sort.md | ||
| env.example | ||
| flightsql.md | ||
| garbage_collector.md | ||
| ingester_querier_protocol.md | ||
| local_filesystems.md | ||
| logging.md | ||
| metrics.md | ||
| multi_core_tasks.md | ||
| observability.md | ||
| physical_plan_construction.md | ||
| profiling.md | ||
| protobuf.md | ||
| retention_policy.md | ||
| sql.md | ||
| style_guide.md | ||
| testing.md | ||
| tracing.md | ||
| underground_guide.md | ||
| valgrind.md | ||
README.md
InfluxDB IOx Documentation
Please see the main README for user facing documentation.
This directory contains internal design documentation of potential interest for those who wish to understand how the code works.
IOx Tech Talks
We hold monthly Tech Talks that explain the project's technical underpinnings. You can register for the InfluxDB IOx Tech Talks here, or you can find links to previous sessions below or in the YouTube playlist:
- December 2020: Rusty Introduction to Apache Arrow recording
- Jan 2021: Data Lifecycle in InfluxDB IOx & How it Uses Object Storage for Persistence recording
- February 2021: Intro to the InfluxDB IOx Read Buffer recording slides
- March 2021: Query Engine Design and the Rust-Based DataFusion in Apache Arrow recording slides
- April 2021: InfluxDB IOx Tech Talks: Replication, Durability and Subscriptions in InfluxDB IOx recording slides
- May 2021: Catalogs - Turning a Set of Parquet Files into a Data Set recording, slides
- June 2021: Performance Profiling in Rust recording, slides
- July 2021: Impacts of Sharding, Partitioning, Encoding & Sorting on Distributed Query Performance recording, slides
- September 2021: Observability of InfluxDB IOx Tracing, Metrics and System Tables recording, slides
- October 2021: Query Processing in InfluxDB IOx recording, slides
- November 2021: The Impossible Dream: Easy-to-Use, Super Fast Software and Simple Implementation recording, slides
Table of Contents:
User Contents
Developer Content
- Rust style and Idiom guide
- Distributed Tracing Guide
- Logging Guide
- Handling Observability Context
- Metrics guide
- Profiling Guide
- Valgrind Guide
- Protobuf tips and tricks
- Testing documentation for developers of IOx
- IOx Architecture
- Data Deduplication & Sort Key
- Transactions and locks (to be written & linked)
- Thoughts on using multiple cores / thread pools
- Compactor
- Data Rentention Policy
- Query Engine Docs
- Notes on the use of local filesystems
- Querier <> Ingester Query Protocol
- Underground Guide to Running IOx Locally