Repository navigation
docs: README around exact types, loud failures and bounded memory, with a re-recorded demo - #336
Merged
Merged
Conversation
Incomplete: README restructure and the re-recorded GIF still to come.
Deploying sqlload with
|
| Latest commit: |
f993768
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://c3b46367.sqlload.pages.dev |
| Branch Preview URL: | https://docs-readme-trust.sqlload.pages.dev |
… Ordinary databases don't swap at once
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.
The README's top says "Exact types. Loud failures. Bounded memory.", but the page below it was still about routing and speed. This restructures it to back up those three claims, in the home page's order, and re-records the demo GIF on the current release.
README (and the PyPI README, which is now an exact copy)
Intro: what SQLLoad loads, what
sqlload planshows (and thatplan -vadds column types and the memory budget, as it has sinceplangot shorter), and one sentence per claim: decimals keep their precision, a value a column can't hold exactly fails its table, naming the column and the value, each run has one memory budget, and tables with a cursor column carry on from the warehouse's own maximum.GIF: re-recorded (see below). Its caption and alt text describe what it now shows.
Why SQLLoad: four bullets with one concrete example each, and a docs link:
decimal(12,2)loads asDECIMAL(12,2), and a pinned type narrower than the live column failsplan.plannames each problem it can find and its fix, a commit whose checks fail publishes none of its rows, commits land whole, and in a warehouse (except a ClickHouseOrdinarydatabase) a full refresh swaps in at once.cursor_columncontinue from the warehouse's own maximum.The Postgres CDC bullet is gone; CDC is in the "What it loads" table.
Speed and memory: the existing table and caption, moved below "Why SQLLoad".
What it loads: DuckDB and MotherDuck are now ticked as sources, since 0.72.0.
Each claim was checked against the docs and a live run on the current release.
Demo recording
.github/demos/plan-load.gifwas from beforeloadstopped printing the whole plan tree. The new one is made by scripts underwebsite/recordings/, laid out like SQLBuild's:prepare.sh <demo>builds a clean project underscratch/(here,sqlload playground shop, plus a copy of its settings withcursor_columnmisspelled).record.sh <demo>renderstapes/<demo>.tapewith VHS into an uncommittedout/.tapes/common.tapeholds the shared settings and a theme matching the website's terminal blocks..github/demos/.The demo runs
sqlload plan, thensqlload load, then one load withcursor_column = "updated", which stops with "did you mean updated_at?". It runs about 15 s, and every frame was checked.Docs
The load page said plain
planshows the memory budget line; it shows it only when it asks something (no budget, the budget off, orconcurrencylowered), andplan -valways does. The page and its example now say so.Verification
README.mdandpackages/sqlload/README.mdare identical (diffis empty).website/recordings/prepare.shfails loudly if the playground's settings change so the misspelling can't be added.