diff --git a/Cargo.lock b/Cargo.lock index cc6c0539..1576b743 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -4644,7 +4644,7 @@ version = "0.8.5" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "03c3c6b7927ffe7ecaa769ee0e3994da3b8cafc8f444578982c83ecb161af917" dependencies = [ - "heck 0.4.1", + "heck 0.5.0", "proc-macro2", "quote", "syn", diff --git a/docs/book.toml b/docs/book.toml index 8556dbb6..7b605960 100644 --- a/docs/book.toml +++ b/docs/book.toml @@ -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"] diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md index e73b455b..b493e45d 100644 --- a/docs/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -1,35 +1,68 @@ # 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]() + - [Cascades Framework]() + - [Rule IR and Matcher]() + - [Cost and Statistics]() + - [Logical Properties]() + - [Physical Properties and Enforcers]() + - [Subgoals and Winner Representation]() + - [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)