Skip to main content

🌪️ Vortex

Build Status OpenSSF Best Practices Documentation CodSpeed Badge Crates.io PyPI - Version Maven - Version codecov Cite

Join the community on Slack! | Documentation | Performance Benchmarks

If you are interested in closer collaboration, please email info@vortex.dev

Overview

Vortex is a next-generation columnar file format and toolkit designed for high-performance data processing. It is the fastest and most extensible format for building data systems backed by object storage. It provides:

  • Blazing Fast Performance

    • 100x faster random access reads (vs. modern Apache Parquet)
    • 10-20x faster scans
    • 5x faster writes
    • Similar compression ratios
    • Efficient support for wide tables with zero-copy/zero-parse metadata
  • Extensible Architecture

    • Modeled after Apache DataFusion's extensible approach
    • Pluggable encoding system, type system, compression strategy, & layout strategy
    • Zero-copy compatibility with Apache Arrow
  • Open Source, Neutral Governance

    • A Linux Foundation (LF AI & Data) Project
    • Apache-2.0 Licensed
  • Integrations

    • Arrow, DataFusion, DuckDB, Spark, Pandas, Polars, & more
    • Apache Iceberg (coming soon)

🟢 Development Status: Library APIs may change from version to version, but we now consider the file format stable. From release 0.36.0, all future releases of Vortex should maintain backwards compatibility of the file format (i.e., be able to read files written by any earlier version >= 0.36.0).

Key Features

Core Capabilities

  • Logical Types - Clean separation between logical schema and physical layout
  • Zero-Copy Arrow Integration - Seamless conversion to/from Apache Arrow arrays
  • Extensible Encodings - Pluggable physical layouts with built-in optimizations
  • Cascading Compression - Support for nested encoding schemes
  • High-Performance Computing - Optimized compute kernels for encoded data
  • Rich Statistics - Lazy-loaded summary statistics for optimization

Technical Architecture

Logical vs Physical Design

Vortex strictly separates logical and physical concerns:

  • Logical Layer: Defines data types and schema
  • Physical Layer: Handles encoding and storage implementation
  • Built-in Encodings: Compatible with Apache Arrow's memory format
  • Extension Encodings: Optimized compression schemes (RLE, dictionary, etc.)

Quick Start

Installation

Rust Crate

All features are exported through the main vortex crate.

cargo add vortex

Python Package

uv add vortex-data

Command Line UI (vx)

For browsing the structure of Vortex files, you can use the vx command-line tool.

# Install pre-built binary (fast, recommended)
cargo binstall vortex-tui

# Or build from source
cargo install vortex-tui --locked

# Or run via Python without installing
uvx --from vortex-data vx --help

# Usage
vx browse <file>

Development Setup

Prerequisites (macOS)

# Optional but recommended dependencies
brew install flatbuffers protobuf  # For .fbs and .proto files
brew install duckdb               # For benchmarks

# Install Rust toolchain
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
# or
brew install rustup

# Initialize submodules
git submodule update --init --recursive

# Setup dependencies with uv
uv sync --all-packages

See the development workflows for Python binding and documentation development, including Maturin rebuilds, targeted tests, and documentation checks.

rust-toolchain.toml pins the toolchain used for development and CI, and is kept on the latest stable release. Building Vortex as a dependency only requires a toolchain that satisfies the Rust version compatibility policy.

Benchmarking

Use vx-bench to run benchmarks comparing engines (DataFusion, DuckDB) and formats (Parquet, Vortex):

# Install the benchmark orchestrator
uv tool install "bench_orchestrator @ ./bench-orchestrator/"

# Run TPC-H benchmarks
vx-bench run tpch --engine datafusion,duckdb --format parquet,vortex

# Compare results
vx-bench compare --run latest

See bench-orchestrator/README.md for full documentation.

Performance Optimization

For optimal performance, we suggest using MiMalloc:

#[global_allocator]
static GLOBAL_ALLOC: MiMalloc = MiMalloc;

Project Information

Rust Version Compatibility Policy

The policy: Vortex supports the four most recent stable minor releases. Writing the latest stable release as 1.N, that means 1.N, 1.N-1, 1.N-2, and 1.N-3 all build Vortex, so the three minor releases older than the latest stable release. Only the minor version is constrained; Minimum Supported Rust Version (MSRV) declared in Cargo.toml must be no newer than 1.N-3, patch releases are never a factor.

An MSRV older than 1.N-3 is always acceptable — supporting extra releases cannot break the guarantee. An MSRV newer than 1.N-3 does not meet the policy. For example, once 1.98 is the latest stable release:

Declared MSRV Status
1.94 or older Acceptable — supports more releases than required
1.95 Exactly on policy
1.96 or newer Does not meet the policy

The MSRV is raised in occasional deliberate steps rather than on every Rust release, so it drifts relative to that bound.

How the policy is applied:

  • The MSRV is declared once, as rust-version in the root Cargo.toml, and inherited by every crate in the workspace. That value, not this document, is the source of truth.
  • The toolchain pinned in rust-toolchain.toml tracks the latest stable release and is independent of the MSRV. It is what contributors and most CI jobs build with.
  • CI enforces the declared MSRV in the Rust (MSRV) job, which builds the publishable crates with exactly that toolchain. When it fails, the first choices are to express the code without the newer Rust feature, or to hold back the dependency update that raised the requirement. Raising rust-version is a last resort.

License

Licensed under the Apache License, Version 2.0.

Governance

Vortex is an independent open-source project and not controlled by any single company. The Vortex Project is a sub-project of the Linux Foundation Projects. The governance model is documented in CONTRIBUTING.md and is subject to the terms of the Technical Charter.

Contributing

Please do read CONTRIBUTING.md before you contribute.

Reporting Vulnerabilities

If you discover a security vulnerability, please email vuln-report@vortex.dev.

Trademarks

Copyright © Vortex a Series of LF Projects, LLC. For terms of use, trademark policy, and other project policies please see https://lfprojects.org

Acknowledgments

The Vortex project benefits enormously from groundbreaking work from the academic & open-source communities.

Research in Vortex

Vortex in Research

  • Anyblox - A Framework for Self-Decoding Datasets
  • F3 - Open-Source Data File Format for the Future

Open Source Inspiration

Thanks to all contributors who have shared their knowledge and code with the community! 🚀

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

vortex_data-0.85.0-cp311-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (41.8 MB view details)

Uploaded CPython 3.11+manylinux: glibc 2.17+ x86-64

vortex_data-0.85.0-cp311-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (39.7 MB view details)

Uploaded CPython 3.11+manylinux: glibc 2.17+ ARM64

vortex_data-0.85.0-cp311-abi3-macosx_11_0_arm64.whl (41.5 MB view details)

Uploaded CPython 3.11+macOS 11.0+ ARM64

vortex_data-0.85.0-cp311-abi3-macosx_10_12_x86_64.whl (43.2 MB view details)

Uploaded CPython 3.11+macOS 10.12+ x86-64

File details

Details for the file vortex_data-0.85.0-cp311-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for vortex_data-0.85.0-cp311-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 a426db0bffac80e31535aa8699beff5f01c3ea474dca775fb76fb44340c11e97
MD5 2c1c62004d1c4b72fa5ee8e005cb5ed1
BLAKE2b-256 e814ba3b3be2095412ed10edd1344f96eff10d9d890b3555c010b75b0ba6ed90

See more details on using hashes here.

Provenance

The following attestation bundles were made for vortex_data-0.85.0-cp311-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl:

Publisher: publish.yml on vortex-data/vortex

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file vortex_data-0.85.0-cp311-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl.

File metadata

File hashes

Hashes for vortex_data-0.85.0-cp311-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 a574bf7bc3037b221fc2a2be30c5783dfc7f8eefe6cd06edc7739e54ba5e2a5f
MD5 c8ced81122321db620329a81e930b661
BLAKE2b-256 e10e7e02d79c1f13311abcf0c80c5a714dd9383c4020beca785e537a52d79b1c

See more details on using hashes here.

Provenance

The following attestation bundles were made for vortex_data-0.85.0-cp311-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl:

Publisher: publish.yml on vortex-data/vortex

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file vortex_data-0.85.0-cp311-abi3-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for vortex_data-0.85.0-cp311-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 7b30e038492f28ea94a8cd5088e3eaf80152486175726e778b61ed259f454a30
MD5 81fd4937f5d80449ed90c805f9f6aac4
BLAKE2b-256 fec40d6cf3b00595f6fbf8a810c7ad7cb65bdd8c483c90d2d6fd10bd5fc6d652

See more details on using hashes here.

Provenance

The following attestation bundles were made for vortex_data-0.85.0-cp311-abi3-macosx_11_0_arm64.whl:

Publisher: publish.yml on vortex-data/vortex

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file vortex_data-0.85.0-cp311-abi3-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for vortex_data-0.85.0-cp311-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 c703f0a8eba2f4fbb8e456e7fc53ea8e271075028b6fd1ffe7471805b68cca9f
MD5 72f85ec61f11cd0942d74a807a5def41
BLAKE2b-256 e99ef81df2bf277e611cd0b9ee134f556b2ef9c1494cf96dfa14d64f2dca3116

See more details on using hashes here.

Provenance

The following attestation bundles were made for vortex_data-0.85.0-cp311-abi3-macosx_10_12_x86_64.whl:

Publisher: publish.yml on vortex-data/vortex

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.85.0 This release

4 files

0.84.0

4 files

0.83.0

4 files

0.82.0

4 files

0.81.0

4 files

0.80.0

4 files

0.79.0

4 files

0.78.0

4 files

0.77.0

4 files

0.76.0

4 files

0.75.0

4 files

0.74.0

4 files

0.73.0

4 files

0.72.0

4 files

0.71.0

4 files

0.70.0

4 files

0.69.0

4 files

0.68.0

4 files

0.67.0

4 files

0.66.0

4 files

0.65.0

4 files

0.64.0

4 files

0.63.0

4 files

0.62.0

4 files

0.61.0

4 files

0.60.0

4 files

0.59.4

4 files

0.59.3

4 files

0.59.2

4 files

0.58.0

4 files

0.57.2

4 files

0.56.0

4 files

0.55.0

4 files

0.54.0

4 files

0.53.0

4 files

0.52.1

4 files

0.52.0

4 files

0.51.0

4 files

0.50.0

4 files

0.49.0

4 files

0.48.0

4 files

0.47.0

4 files

0.46.1

4 files

0.46.0

4 files

0.45.0

4 files

0.44.1

4 files

0.44.0

4 files

0.43.0

4 files

0.42.1

4 files

0.42.0

4 files

0.41.2

4 files

0.40.0

4 files

0.39.0

4 files

0.38.0

4 files

0.37.2

4 files

0.37.1

4 files

0.36.1

4 files

0.36.0

4 files

0.35.0

4 files

0.34.0

4 files

0.33.2

4 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page