docs: state ASAPPlanner's motivation, assumptions and extension scenarios - #533
Merged
Merged
Conversation
…rios Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
planner-layering.md(#509) said what ASAPPlanner returns, but not why it exists or which assumptions it relies on. Readers had to infer, for example, whether rewrite rules or summary capabilities are discovered automatically (they are not). The doc also did not show how the design is extended.What
Documentation only, in
docs/design_docs/proposals/planner-layering.md.Goal → Motivation. Existing query engines and optimizers do not consider ASAP primitives, or the query and data workloads of different use cases: streaming or batch input, and repeated, batch or ad hoc queries. So they miss sharing the benefits of ASAP primitives across domains and use cases. ASAPPlanner therefore models four things for an existing query IR: query workloads, data workloads, deployment inputs, and ASAP replacement strategies.
Goal → Assumptions. An explicit, complete list:
Scenarios (new section). Each one lists what is given, what is automatic, what stays unchanged, and the current gaps (linked issues):
Before this PR
The Goal section was one paragraph about inputs and outputs. No motivation, no stated assumptions, no extension walkthrough.
After this PR
For example, a reader adding a new quantile sketch finds which six things they must declare and implement. ASAPPlanner then offers, sizes, shares and selects the sketch automatically. The reader also sees which current limitations apply (#523, #524).
🤖 Generated with Claude Code