Repository navigation
Document the file-backed parser architecture - #31
Merged
Merged
Conversation
There was a problem hiding this comment.
🟡 Changes recommended
The document does not clearly enumerate currently supported syntax or distinguish it from planned behavior.
1 open finding
What changed in this PR
Documents sqlread’s file-backed, bounded-memory architecture and future design constraints.
Changes:
- Defines scanner, indexing, execution, cancellation, and cache contracts.
- Identifies current memory-related refinement areas.
| File | Description |
|---|---|
ARCHITECTURE.md |
Adds architectural principles and implementation guidance. |
🧠 Review effort: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+21
to
+22
| sqlread supports a deliberate subset of dump formats and query syntax. Full SQL | ||
| compatibility is not a requirement. Document the supported syntax as it evolves. |
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.
sqlread has already handled dumps far larger than available memory on machines with limited memory. Future changes must preserve that capability. The architecture needs to state this goal explicitly.
Add
ARCHITECTURE.mdwith Rob Pike's Lexical Scanning in Go as the scanner's foundation. Treat the file as memory. Define bounded buffers, source spans, index storage, query execution, cancellation, and cache behavior. Identify areas for measurement or refinement.State the supported-syntax scope, read-only source contract, and failure behavior. Prefer minimal explicit state and integration and functional tests.
Validation: checked the talk references, local file links, and diff whitespace. Documentation only. No runtime code changed.