docs: add usage examples and architecture guide (Phase 2)#22
Merged
AWaterColorPen merged 1 commit intomainfrom Apr 22, 2026
Merged
docs: add usage examples and architecture guide (Phase 2)#22AWaterColorPen merged 1 commit intomainfrom
AWaterColorPen merged 1 commit intomainfrom
Conversation
- docs/examples.md: 7 real-world usage scenarios * Simple single-table ClickHouse query * Time-range filter with TimeInterval * Custom metrics formula (composition / ratio) * Multi-table JOIN (fact_dimension_join) query * RunSync vs RunChan (sync vs streaming) * Debug: BuildSQL without executing * SQLite quick-start for local development - docs/architecture.md: contributor-focused architecture guide * Component responsibilities (Manager, Dictionary, Translator, Clause, Clients, Result) * Full request lifecycle walkthrough * Data-flow diagram * Package layout table * Key design decisions and extension points - spec: mark examples and architecture tasks as done
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.
Phase 2 — Usage Examples & Architecture Guide
This PR fills in the two stub docs added in the previous PR, replacing the placeholder content with complete documentation.
docs/examples.md — 7 real-world usage scenarios
time_interval— shows auto-expansion to WHERE clause; includes a second example with extra filters, ORDER BY, and LIMITMETRIC_DIVIDE,METRIC_ADD, etc.) with TOML schema + query + generated SQLfact_dimension_joinwith two chained dimension tables; schema, query, and generated SQL with JOIN chainDebug: trueandSetLoggertest/dictionary.sqlite.toml; no ClickHouse neededdocs/architecture.md — contributor guide
RunSyncto rows)Part of
Phase 2: Documentation — spec