docs(file formats): json_pointer routes a jsonl dataset through Spice's JSON reader - #2140
Merged
Conversation
Contributor
✅ Pull with Spice PassedPassing checks:
|
Contributor
|
🚀 deployed to https://8d94a93e.spiceai-org-website.pages.dev |
Collaborator
Author
|
@copilot review |
Contributor
Reviewed the current branch state for this PR comment. No additional changes are needed from this review request. |
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
Corrects JSONL reader behavior documentation across supported releases.
Changes:
- Documents pointer-based routing through Spice’s JSON reader.
- Clarifies
auto,json_format, andflatten_jsonbehavior.
File summaries
| File | Description |
|---|---|
website/docs/reference/file_format.md |
Updates current reference. |
website/versioned_docs/version-2.0.x/reference/file_format.md |
Updates 2.0 reference. |
website/versioned_docs/version-2.1.x/reference/file_format.md |
Updates 2.1 reference. |
website/versioned_docs/version-2.2.x/reference/file_format.md |
Updates 2.2 reference. |
Review details
- Files reviewed: 4/4 changed files
- Comments generated: 4
- Review effort level: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
…on_pointer routing Each versioned page now links the format-dispatch code for its own release line. The path is not the same across them — v2.0 and v2.1 carry it at crates/runtime/src/dataconnector/listing/connector.rs, and v2.2 onward at crates/data-connector-api/src/listing/connector.rs — so a single link would have been wrong on three of the four pages.
Contributor
|
🚀 deployed to https://c0a9c23f.spiceai-org-website.pages.dev |
lukekim
approved these changes
Sep 1, 2026
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.
Summary
The File Formats reference states, flatly:
The
json_pointerhalf is wrong, and has been since v2.0.0. The JSONL dispatch arm branches on whether a pointer is configured:With a non-empty
json_pointer(or itsjson_pathalias) the dataset is read bySpiceJsonFormat, not DataFusion'sJsonFormat— so the pointer is applied, andget_json_formatalso readsjson_formatandflatten_jsonon that path. All three of the parameters the sentence rules out are live.There is a second, quieter consequence the sentence hid: that branch passes
Format::Autoas the default parsing mode, so the extracted sub-value is content-detected (array / single object / line-delimited) rather than being read as JSON Lines. A reader who setfile_format: jsonlfor a line-delimited sub-document getsautounless they also setjson_format: jsonl, which the page gave them no reason to expect.What changed
One sentence, rewritten to keep the two branches distinct: the plain JSONL path (where
json_formatandflatten_jsonreally are ignored), the pointer path (where all three take effect), and theautostarting mode on that path.Version scope
The branch landed in spiceai/spiceai#9743, first tagged
v2.0.0— soversion-2.0.x,version-2.1.x,version-2.2.xand vNext all carry the wrong sentence and are all fixed here.version-1.11.xand older say "withoutjson_formatorflatten_jsonsupport" — nojson_pointerclaim, correct for those releases — and are deliberately untouched.Source refs
crates/data-connector-api/src/listing/connector.rs— thejsonl | ndjson | ldjsonarm andget_json_format/get_jsonl_format(origin/trunk); same arm atcrates/runtime/src/dataconnector/listing/connector.rsinv2.0.1/v2.1.5JSON file format improvements(commit32772f7521, first tagv2.0.0)Test plan
cd website && npm run buildpassesgrep -rn "uses the DataFusion JSON Lines reader directly" docs/ versioned_docs/returns 5 hits: the 4 corrected here plusversion-1.11.x, which is correct as written