docs: document the engine, its SQL surface, and the design decisions - #56
Merged
Conversation
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
1 participant
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.
README covering what the engine is and is not, a verbatim REPL session over the bundled examples, the supported SQL grammar, the CSV/schema format, the architecture and package layout, how to run and replay the differential tests, and a table of deliberate divergences from SQLite.
docs/design-notes.mdis the engineering write-up: why operators pull rather than push (and which ones cannot be lazy), why a hash join beats a nested loop and what it costs in memory, the two details that make joins subtly wrong if missed, three-valued logic and the one place SQL treats NULL as a value instead, why name resolution happens at plan time, and what an oracle buys that golden tests cannot — including the generator gap I had to fix and the rule that a disagreement is either a bug or documented, never a widened tolerance.Every command in the README was run and its real output pasted.
Closes #48