Skip to content
This repository was archived by the owner on Jan 7, 2025. It is now read-only.

Commit 143acf7

Browse files
committed
docs: layout the new optd book
Signed-off-by: Alex Chi Z <[email protected]>
1 parent d77b3e3 commit 143acf7

File tree

3 files changed

+70
-33
lines changed

3 files changed

+70
-33
lines changed

Cargo.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/book.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ authors = ["Alex Chi"]
33
language = "en"
44
multilingual = false
55
src = "src"
6-
title = "Introduction to optd"
6+
title = "the optd book"
77

88
[output.html]
99
additional-css = ["custom.css"]

docs/src/SUMMARY.md

Lines changed: 68 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,72 @@
11
# Summary
22

3-
# The Core Framework
3+
# optd book
44

5-
- [Optimizer](./optimizer.md)
6-
- [Plan Representation](./plan_repr.md)
7-
- [Rule Engine](./rule_engine.md)
8-
- [Cost Model](./cost_model.md)
9-
- [Properties](./properties.md)
5+
[Intro to optd]()
6+
- [The Core]()
7+
- [Plan Representation]()
8+
- [Memo Table]()
9+
- [Cascades Framework]()
10+
- [Basic Cascades Tasks]()
11+
- [Upper Bound Pruning]()
12+
- [Multi-Stage Optimization]()
13+
- [Rule IR and Matcher]()
14+
- [Cost and Statistics]()
15+
- [Logical Properties]()
16+
- [Physical Properties and Enforcers]()
17+
- [Memo Table: Subgoals and Winners]()
18+
- [Cascades Tasks: Required Physical Properties]()
19+
- [Exploration Budget]()
20+
- [Heuristics Optimizer]()
21+
- [Integration with Datafusion]()
22+
- [Datafusion Plan Representation]()
23+
- [Datafusion Bridge]()
24+
- [Rule Engine and Rules]()
25+
- [Basic Cost Model]()
26+
- [Logical and Physical Properties]()
27+
- [Optimization Passes]()
28+
- [Miscellaneous]()
29+
- [Explain]()
30+
- [Research]()
31+
- [Partial Exploration and Re-Optimization]()
32+
- [Advanced Cost Model]()
33+
- [The Hyper Subquery Unnesting Ruleset]()
34+
- [Testing and Benchmark]()
35+
- [sqlplannertest]()
36+
- [sqllogictest]()
37+
- [perfbench]()
38+
- [Debugging and Tracing]()
39+
- [optd-core Tracing]()
40+
- [Memo Table Visualization]()
41+
- [Optimizer Dump]()
42+
- [Contribution Guide]()
43+
- [Install Tools]()
44+
- [Contribution Workflow]()
45+
- [Add a Datafusion Rule]()
46+
- [What's Next]()
47+
- [Ideas]()
48+
- [RFCs]()
49+
---
1050

11-
# Integration
12-
13-
- [Apache Arrow Datafusion](./datafusion.md)
14-
15-
# Adaptive Optimization
16-
17-
- [Re-optimization](./reoptimization.md)
18-
- [Partial Exploration](./partial_exploration.md)
19-
20-
# Demo
21-
22-
- [Three Join Demo](./demo_three_join.md)
23-
- [TPC-H Q8 Demo](./demo_tpch_q8.md)
24-
25-
# Performance Benchmarking
26-
- [Cost Model Cardinality Benchmarking](./cost_model_benchmarking.md)
27-
28-
# Functional Testing
29-
30-
- [SQLPlannerTest](./sqlplannertest.md)
31-
- [Datafusion CLI](./datafusion_cli.md)
32-
33-
# Miscellaneous
34-
35-
- [Miscellaneous](./miscellaneous.md)
51+
# DEPRECATED
52+
- [old optd book]()
53+
- [Core Framework]()
54+
- [Optimizer](./optimizer.md)
55+
- [Plan Representation](./plan_repr.md)
56+
- [Rule Engine](./rule_engine.md)
57+
- [Cost Model](./cost_model.md)
58+
- [Properties](./properties.md)
59+
- [Integration]()
60+
- [Apache Arrow Datafusion](./datafusion.md)
61+
- [Adaptive Optimization]()
62+
- [Re-optimization](./reoptimization.md)
63+
- [Partial Exploration](./partial_exploration.md)
64+
- [Demo]()
65+
- [Three Join Demo](./demo_three_join.md)
66+
- [TPC-H Q8 Demo](./demo_tpch_q8.md)
67+
- [Performance Benchmarking]()
68+
- [Cost Model Cardinality Benchmarking](./cost_model_benchmarking.md)
69+
- [Functional Testing]()
70+
- [SQLPlannerTest](./sqlplannertest.md)
71+
- [Datafusion CLI](./datafusion_cli.md)
72+
- [Miscellaneous](./miscellaneous.md)

0 commit comments

Comments
 (0)