Back to Lance

Versioning

docs/src/format/file/versioning.md

4.0.12.2 KB
Original Source

Versioning

The Lance file format has a single version number for both the overall file format and the encoding strategy. The major number is changed when the file format itself is modified while the minor number is changed when only the encoding strategy is modified. Newer versions will typically have better performance and compression but may not be readable by older versions of Lance.

In addition, the next alias points to an unstable format version and should not be used for production use cases. Breaking changes could be made to unstable encodings and that would mean that files written with these encodings are no longer readable by any newer versions of Lance. The next version should only be used for experimentation and benchmarking upcoming features.

The stable and next aliases are resolved by the specific Lance release you are using. During a format rollout (for example, 2.2), prefer explicit version pinning for deterministic behavior across environments.

The following values are supported:

VersionMinimal Lance VersionMaximum Lance VersionDescription
0.1Any0.34 (write)This is the initial Lance format. It is no longer writable.
2.00.16.0AnyRework of the Lance file format that removed row groups and introduced null support for lists, fixed size lists, and primitives
2.10.38.1AnyEnhances integer and string compression, adds support for nulls in struct fields, and improves random access performance with nested fields.
2.2 (unstable)NoneAnyAdds support for newer nested type/encoding capabilities (including map support) and 2.2-era storage features.
legacyN/AN/AAlias for 0.1
stableN/AN/AAlias for the latest stable version in the Lance release you are running.
nextN/AN/AAlias for the latest unstable version in the Lance release you are running.