docs: add release badge and real-world recipes#18
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the project README to better meet Issue #6’s documentation acceptance criteria by adding missing repository metadata and expanding practical usage guidance.
Changes:
- Add a “Latest release” badge alongside existing CI and license badges.
- Add a new “Recipes” section with 6 copy/paste SQL examples for common CSV workflows.
- Fix the Exit Codes table separator formatting.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| **Find rows with missing values:** | ||
|
|
||
| ```sh | ||
| $ cat users.csv | sql-pipe 'SELECT * FROM t WHERE email = "" OR email IS NULL' |
There was a problem hiding this comment.
In these recipes, empty CSV fields are inserted as SQL NULL (see insertRowTyped binding behavior), so email = "" will never match. Consider simplifying to email IS NULL (and optionally OR TRIM(email) = '' if you want to treat whitespace-only values as missing).
Suggested change
| $ cat users.csv | sql-pipe 'SELECT * FROM t WHERE email = "" OR email IS NULL' | |
| $ cat users.csv | sql-pipe 'SELECT * FROM t WHERE email IS NULL OR TRIM(email) = ""' |
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.
Closes #6
What changed
Acceptance criteria check
t)--helpflag documented