Skip to content

docs: add real-world examples and JSON/NDJSON input documentation#128

Merged
vmvarela merged 1 commit intomasterfrom
issue-127/real-world-examples-and-json-input-docs
May 1, 2026
Merged

docs: add real-world examples and JSON/NDJSON input documentation#128
vmvarela merged 1 commit intomasterfrom
issue-127/real-world-examples-and-json-input-docs

Conversation

@vmvarela
Copy link
Copy Markdown
Owner

@vmvarela vmvarela commented May 1, 2026

Summary

  • Fixes the broken chain example in Usage (was missing -H on first call, causing "no such column" errors in the second pass)
  • Updates the intro and Usage section to reflect JSON/NDJSON input support (-I json, -I ndjson)
  • Adds -I/--input-format and -O/--output-format to the flags table
  • Adds a Real-world examples section with 6 verified live examples

Examples added

Example Format Shows
La Liga all-time home wins (1929–present) CSV GROUP BY, CAST
La Liga highest-scoring seasons CSV --json output
OWID energy: top solar countries 2023 CSV large public dataset
OWID energy: wind + solar two-pass CSV chaining with -H
restcountries Europe population density NDJSON + jq -I ndjson, live API
Open-Meteo 7-day Madrid forecast NDJSON + jq -I ndjson, real-time data

All examples were run and outputs verified against the current dev build.

Closes #127

- Update intro: 'reads CSV from stdin' → 'reads CSV, JSON, or NDJSON'
- Add JSON/NDJSON input paragraph and example to Usage section
- Add -I/--input-format and -O/--output-format to flags table
- Fix broken chain example (missing -H on first sql-pipe call)
- Add Real-world examples section with 6 verified live examples:
  La Liga wins/goals (CSV), OWID energy solar/wind (CSV+chain),
  restcountries density (NDJSON), Open-Meteo Madrid forecast (NDJSON)

Closes #127
@vmvarela vmvarela merged commit 4856992 into master May 1, 2026
5 checks passed
@vmvarela vmvarela deleted the issue-127/real-world-examples-and-json-input-docs branch May 1, 2026 17:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add real-world examples and JSON/NDJSON input docs to README

1 participant