Skip to content

docs: clarify vortex-row is not production-ready #8949

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
joseph-isaacs merged 1 commit into from
Jul 27, 2026
+5 −5
Merged

docs: clarify vortex-row is not production-ready #8949

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
10 changes: 5 additions & 5 deletions vortex-row/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# vortex-row

`vortex-row` provides an experimental row-oriented byte encoder for Vortex arrays. It
produces byte strings that can be compared lexicographically to sort rows according to the
configured column ordering.
`vortex-row` provides an experimental row-oriented byte encoder for Vortex arrays. It is
**not ready for production use**. It produces byte strings that can be compared
lexicographically to sort rows according to the configured column ordering.

Only supported Vortex logical types are accepted. Extension types are rejected until their
logical sort semantics are defined.

## Experimental Format

The row encoding byte layout is experimental. Its exact bytes, supported type set, and
edge-case semantics may change between Vortex releases.
The row encoding byte layout is experimental and not ready for production. Its exact bytes,
supported type set, and edge-case semantics may change between Vortex releases.

Do not persist row-encoded bytes or use them as a stable interchange format. They are intended
for internal sort-key and row-key operations where the encoder version, schema, and sort
Expand Down
Loading