Skip to content

Commit

Permalink
docs: layout the new optd book (#270)
Browse files Browse the repository at this point in the history
Signed-off-by: Alex Chi Z <iskyzh@gmail.com>
  • Loading branch information
skyzh authored Dec 19, 2024
1 parent d77b3e3 commit edd5d2f
Show file tree
Hide file tree
Showing 3 changed files with 71 additions and 33 deletions.
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/book.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ authors = ["Alex Chi"]
language = "en"
multilingual = false
src = "src"
title = "Introduction to optd"
title = "the optd book"

[output.html]
additional-css = ["custom.css"]
100 changes: 69 additions & 31 deletions docs/src/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,73 @@
# Summary

# The Core Framework
# optd book

- [Optimizer](./optimizer.md)
- [Plan Representation](./plan_repr.md)
- [Rule Engine](./rule_engine.md)
- [Cost Model](./cost_model.md)
- [Properties](./properties.md)
[Intro to optd]()
- [The Core]()
- [Plan Representation]()
- [Memo Table and Logical Equivalence]()
- [Cascades Framework]()
- [Basic Cascades Tasks]()
- [Cycle Avoidance]()
- [Upper Bound Pruning]()
- [Multi-Stage Optimization]()
- [Rule IR and Matcher]()
- [Cost and Statistics]()
- [Logical Properties]()
- [Physical Properties and Enforcers]()
- [Memo Table: Subgoals and Winners]()
- [Cascades Tasks: Required Physical Properties]()
- [Exploration Budget]()
- [Heuristics Optimizer]()
- [Integration with Datafusion]()
- [Datafusion Plan Representation]()
- [Datafusion Bridge]()
- [Rule Engine and Rules]()
- [Basic Cost Model]()
- [Logical and Physical Properties]()
- [Optimization Passes]()
- [Miscellaneous]()
- [Explain]()
- [Research]()
- [Partial Exploration and Re-Optimization]()
- [Advanced Cost Model]()
- [The Hyper Subquery Unnesting Ruleset]()
- [Testing and Benchmark]()
- [sqlplannertest]()
- [sqllogictest]()
- [perfbench]()
- [Debugging and Tracing]()
- [optd-core Tracing]()
- [Memo Table Visualization]()
- [Optimizer Dump]()
- [Contribution Guide]()
- [Install Tools]()
- [Contribution Workflow]()
- [Add a Datafusion Rule]()
- [What's Next]()
- [Ideas]()
- [RFCs]()
---

# Integration

- [Apache Arrow Datafusion](./datafusion.md)

# Adaptive Optimization

- [Re-optimization](./reoptimization.md)
- [Partial Exploration](./partial_exploration.md)

# Demo

- [Three Join Demo](./demo_three_join.md)
- [TPC-H Q8 Demo](./demo_tpch_q8.md)

# Performance Benchmarking
- [Cost Model Cardinality Benchmarking](./cost_model_benchmarking.md)

# Functional Testing

- [SQLPlannerTest](./sqlplannertest.md)
- [Datafusion CLI](./datafusion_cli.md)

# Miscellaneous

- [Miscellaneous](./miscellaneous.md)
# DEPRECATED
- [old optd book]()
- [Core Framework]()
- [Optimizer](./optimizer.md)
- [Plan Representation](./plan_repr.md)
- [Rule Engine](./rule_engine.md)
- [Cost Model](./cost_model.md)
- [Properties](./properties.md)
- [Integration]()
- [Apache Arrow Datafusion](./datafusion.md)
- [Adaptive Optimization]()
- [Re-optimization](./reoptimization.md)
- [Partial Exploration](./partial_exploration.md)
- [Demo]()
- [Three Join Demo](./demo_three_join.md)
- [TPC-H Q8 Demo](./demo_tpch_q8.md)
- [Performance Benchmarking]()
- [Cost Model Cardinality Benchmarking](./cost_model_benchmarking.md)
- [Functional Testing]()
- [SQLPlannerTest](./sqlplannertest.md)
- [Datafusion CLI](./datafusion_cli.md)
- [Miscellaneous](./miscellaneous.md)

0 comments on commit edd5d2f

Please sign in to comment.