4e25147062
* docs: Copy edit existing style guide I can't help myself. * docs: Codify our preference for no return type in test functions |
||
|---|---|---|
| .. | ||
| drawings | ||
| README.md | ||
| data_management.md | ||
| encoding_thoughts.md | ||
| env.example | ||
| multi_core_tasks.md | ||
| protobuf.md | ||
| regenerating_flatbuffers.md | ||
| style_guide.md | ||
| testing.md | ||
| tracing.md | ||
README.md
InfluxDB IOx Documentation
This directory contains internal design documentation of potential interest for those who wish to understand how the code works. It is not intended to be general user facing documentation
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:
- 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
Table of Contents:
- Rust style and Idiom guide: style_guide.md
- Tracing and logging Guide: tracing.md
- How InfluxDB IOx manages the lifecycle of time series data: data_management.md
- Thoughts on parquet encoding and compression for timeseries data: encoding_thoughts.md
- Thoughts on using multiple cores: multi_core_tasks.md
- Query Engine Docs
- Testing documentation for developers of IOx
- Regenerating Flatbuffers code when updating the version of the
flatbufferscrate - Protobuf tips and tricks: Protobuf.