docs: Document compressed file extension auto-detection#1726
Merged
Conversation
Listing data connectors (S3, ABFS, GCS, HTTP/HTTPS, FTP, SFTP, SMB, NFS, file) now auto-detect both file format and compression codec from compound extensions like `.csv.gz`, `.jsonl.zst`, `.tsv.xz`, `.json.bz2`. No `file_compression_type` parameter is required for the recognized suffixes (`.gz`, `.bz2`, `.xz`, `.zst`). - Updates the Common Parameters table: `file_extension` and `file_compression_type` now mention compound-extension inference. - Adds a new "Compressed File Extensions" section with the format/ compression mapping and an example. Reflects the behavior introduced in spiceai/spiceai#10809.
✅ Pull with Spice PassedPassing checks:
|
🔍 Pull with Spice FailedPassing checks:
Failed checks:
Please address these issues and update your pull request. |
|
🚀 deployed to https://11aa3066.spiceai-org-website.pages.dev |
phillipleblanc
approved these changes
May 14, 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
Listing data connectors now auto-detect both file format and compression codec from compound file extensions such as
.csv.gz,.jsonl.zst,.tsv.xz, and.json.bz2. Nofile_compression_typeparameter is required for the recognized suffixes (.gz,.bz2,.xz,.zst).Source PRs
Changes
website/docs/reference/file_format.mdfile_extensionaccepts compound extensions andfile_compression_typeis now inferred when unset.Test plan
cd website && npm run buildpasses locallygz,bz2,xz,zst) verified againstparse_extension_components/compression_from_extensionincrates/runtime/src/dataconnector/listing/mod.rsis_structured_formatanddefault_jsonl_extensionin the same PR