Skip to main content

Python bindings for Vortex, an Apache Arrow-compatible toolkit for working with compressed array data.

Project description

🌪️ Vortex

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

📚 Documentation | 📊 Performance Benchmarks

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

    • 200x faster random access reads (vs. modern Apache Parquet)
    • 2-10x faster scans
    • 2-10x 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 latest release
cargo install vortex-tui --locked

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

# 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

Performance Optimization

For optimal performance, we suggest using MiMalloc:

#[global_allocator]
static GLOBAL_ALLOC: MiMalloc = MiMalloc;

Project Information

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

See CONTRIBUTING.md for guidelines.

Reporting Vulnerabilities

If you discovery 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

  • BtrBlocks - Efficient columnar compression
  • FastLanes - High-performance integer compression
  • FSST - Fast random access string compression
  • ALP - Adaptive lossless floating-point compression
  • Procella - YouTube's unified data system
  • Anyblob - High-performance access to object storage
  • ClickHouse - Fast analytics for everyone

Vortex in Research

  • Anyblox - A Framework for Self-Decoding Datasets

Open Source Inspiration

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

Project details


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.50.0-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (9.3 MB view details)

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

vortex_data-0.50.0-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (8.7 MB view details)

Uploaded CPython 3.10+manylinux: glibc 2.17+ ARM64

vortex_data-0.50.0-cp310-abi3-macosx_11_0_arm64.whl (9.5 MB view details)

Uploaded CPython 3.10+macOS 11.0+ ARM64

vortex_data-0.50.0-cp310-abi3-macosx_10_12_x86_64.whl (10.1 MB view details)

Uploaded CPython 3.10+macOS 10.12+ x86-64

File details

Details for the file vortex_data-0.50.0-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for vortex_data-0.50.0-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 1983cc2cc9c54f5813dc83156902fc58ca8d4213ed3ed863a8f28e275c1a1915
MD5 e981076bc9365e7201e0efd8540dabcd
BLAKE2b-256 8e190c54c450542f67be39db206841e67afc9f1cad266bd6c33bea83c1e408d2

See more details on using hashes here.

Provenance

The following attestation bundles were made for vortex_data-0.50.0-cp310-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.50.0-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl.

File metadata

File hashes

Hashes for vortex_data-0.50.0-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 c307d5ca8cd47ef16d3bd4b1744cfd123edcbc1ba94aa9248b00211f58e12d61
MD5 c541cf4eb3226f48d3635aebf7644135
BLAKE2b-256 eec999e24514ce97379278d9d7b27e19161a9b4bc215e0a0417f0fd52e5e66b4

See more details on using hashes here.

Provenance

The following attestation bundles were made for vortex_data-0.50.0-cp310-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.50.0-cp310-abi3-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for vortex_data-0.50.0-cp310-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 873eb7c854299df6b4e18c46d0bdbf2d0f47f808ac330b71b74b53b97110e07d
MD5 18c444375d55c0cc14035d18aa212396
BLAKE2b-256 5f7dde688117b451902833fcae60bc32c9c6f978d04098c58342fec1e2fe6bb8

See more details on using hashes here.

Provenance

The following attestation bundles were made for vortex_data-0.50.0-cp310-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.50.0-cp310-abi3-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for vortex_data-0.50.0-cp310-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 6e28f8d256155dd977f2fbed39fe3e8daed82549cb93f6fdaec35533f24a393d
MD5 7cef217586aeb039531b7fd9c5a36635
BLAKE2b-256 08e689c6bd865475d332115e7702e402146e3cf216113724bc1a054cbc3cb61e

See more details on using hashes here.

Provenance

The following attestation bundles were made for vortex_data-0.50.0-cp310-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.

Supported by

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