docs: introduce Vortex editions for users of the file format#8852
Closed
joseph-isaacs wants to merge 1 commit into
Closed
docs: introduce Vortex editions for users of the file format#8852joseph-isaacs wants to merge 1 commit into
joseph-isaacs wants to merge 1 commit into
Conversation
An edition names the exact set of encodings a writer may put in a file, giving every file written under it a forever read-and-execute guarantee. This spec page explains the model for users of Vortex: editions constrain writers while readers are cumulative, family-namespaced editions (core2026.07.0) compose additively, writer presets choose within an edition without affecting portability, and unknown-encoding errors link back to the registry. Defines the first edition core2026.07.0 (the 32 encodings the default writer emits today) and the core2026.10.0 draft. Signed-off-by: "Claude" <noreply@anthropic.com> Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01KdR42Svu74NcNzC7XJYwLr
Contributor
Polar Signals Profiling ResultsLatest Run
Powered by Polar Signals Cloud |
Contributor
Benchmarks: Vortex queries 📖Verdict: No clear signal (low confidence) How to read Verdict and Engines
datafusion / vortex-file-compressed (1.036x ➖, 0↑ 0↓)
datafusion / parquet (0.976x ➖, 0↑ 0↓)
duckdb / vortex-file-compressed (1.002x ➖, 0↑ 0↓)
duckdb / parquet (1.010x ➖, 0↑ 0↓)
No file size changes detected. |
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.
Rationale for this change
Vortex needs a named, user-visible compatibility contract for which encodings a writer may put in a file. This PR introduces editions: a named grouping of encodings that records exactly which encodings a Vortex file may contain and when each encoding joined the set. Writing under an edition guarantees every future Vortex release can read — and execute queries over — the file. The concept fills the forward/backward-compatibility seam already noted in
register_default_encodings("different Vortex 'Editions' that may support different sets of encodings") and gives unknown-encoding errors a stable docs page to link to. A follow-up PR adds the Rust implementation (vortex-editioncrate) and the generated registry.What changes are included in this PR?
docs/specs/editions.md— a user-facing spec page, structured around what readers need: the definition (edition = which encodings, added when), a step-by-step "resolving an unknown-encoding error" section, writing with an edition (default just works; pin older editions; additive families; explicit opt-out), how editions change (frozen sets, drafts, deprecation never breaks reads, edition ≠ file-format version), and the registry.ALLOWED_ENCODINGSinvortex-file, includingvortex.zstdsincezstdis a default feature) — and the core2026.10.0 draft as the staging area for the next edition. Experimental encodings (vortex.onpair,vortex.zstd_buffers,vortex.patched,vortex.piecewise-sequence) are explicitly excluded.Docs-only change; validated with a clean
uv run --all-packages make -C docs htmlbuild.What APIs are changed? Are there any user-facing changes?
No API changes. New user-facing documentation page at
docs.vortex.dev/specs/editions.html.🤖 Generated with Claude Code
https://claude.ai/code/session_01KdR42Svu74NcNzC7XJYwLr