Skip to content

docs(compatibility): bump reference to v0.74.0, document gaps #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dfa1 merged 1 commit into from
Jun 10, 2026
Merged

docs(compatibility): bump reference to v0.74.0, document gaps #26

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 16 additions & 2 deletions docs/compatibility.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,17 @@
# Compatibility

Tested against the [Rust reference implementation](https://github.com/vortex-data/vortex) v0.72.0.
Tested against the [Rust reference implementation](https://github.com/vortex-data/vortex) v0.74.0.
For the rest of the API surface (reader, writer, scan, CLI), see [reference.md](reference.md).

## Known wire-format gaps

| Item | Introduced | Java status |
|------|------------|-------------|
| `DType::Union` (`fbs.DType.Type.Union = 12`) | Rust 0.71.0 | ❌ Decode throws `VortexException("unsupported DType typeType=12")`. No `DType.Union` variant in Java's sealed type. |
| `vortex.onpair` experimental string encoding | Rust 0.74.0 | ❌ Not registered. Files using it fail to decode unless `Registry.allowUnknown()` is enabled. |
| `vortex.variant` write path | Rust 0.73.0 (`Allow writing Variant to files`, #7945) | ❌ Java decode works; Java encode throws `"encode not yet implemented"`. Java→Rust round-trip not possible for Variant columns. |
| Arrow extension array import affecting Variant shape | Rust 0.74.0 (#8125) | Untested. Re-run integration fixtures against v0.74.0 once published. |

## Encodings

| Encoding ID | Class | Decode | Encode | Notes |
Expand Down Expand Up @@ -39,7 +48,8 @@ For the rest of the API surface (reader, writer, scan, CLI), see [reference.md](
| `fastlanes.for` | `FrameOfReferenceEncoding` | ✅ | ✅ | Integer PTypes |
| `fastlanes.rle` | `RleEncoding` | ✅ | ✅ | Chunk-based RLE |
| `vortex.patched` | `PatchedEncoding` | ✅ | ❌ | Primitive PTypes; encode not yet implemented |
| `vortex.variant` | `VariantEncoding` | ✅ | ❌ | Encode not yet implemented |
| `vortex.variant` | `VariantEncoding` | ✅ | ❌ | Decode (incl. shredded child); encode not yet implemented (Rust 0.73+) |
| `vortex.onpair` | _none_ | ❌ | ❌ | Experimental in Rust 0.74.0; not yet ported |

### Unknown encodings

Expand Down Expand Up @@ -123,6 +133,10 @@ themselves.

## S3 Fixture Status (v0.72.0)

> **Note:** the fixture matrix below is locked to `v0.72.0/`. The Rust reference is
> now at `v0.74.0`; re-run the integration suite against `v0.74.0/arrays/` once
> upstream publishes the corresponding fixture set, and refresh this section.

Cross-language round-trips tested against Rust-written fixture files hosted at
`s3://vortex-compat-fixtures/v0.72.0/arrays/`.

Expand Down
Loading