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

📚 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.43.0-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (10.1 MB view details)

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

vortex_data-0.43.0-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (9.3 MB view details)

Uploaded CPython 3.10+manylinux: glibc 2.17+ ARM64

vortex_data-0.43.0-cp310-abi3-macosx_11_0_arm64.whl (10.1 MB view details)

Uploaded CPython 3.10+macOS 11.0+ ARM64

vortex_data-0.43.0-cp310-abi3-macosx_10_12_x86_64.whl (10.9 MB view details)

Uploaded CPython 3.10+macOS 10.12+ x86-64

File details

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

File metadata

File hashes

Hashes for vortex_data-0.43.0-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 55ff40933535ad70297aedca29ded981abd11a9f2137cd391c50121b7fdc9980
MD5 c586766283f36de9b121df9356385a9c
BLAKE2b-256 cb0b53f36b2481fc577224daaec1ce77667ac89456f79cf43812538bf623223a

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for vortex_data-0.43.0-cp310-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 8f38cbb6078ad25fad60fa6599079fa437080a9f6098e21525969dc7ea949272
MD5 014864ca34338cc2113f2852ea1bd0ab
BLAKE2b-256 43397536d932a34a911ff36bbb55374bca16ddb60ee1a89ce31ac074163a6837

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for vortex_data-0.43.0-cp310-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 489cf2f1dd10f78d7053de9ebe421d20368b4dbd2be7366f450afd4a2c5a0586
MD5 aeb9956fe7402a1d22bc319743dbc135
BLAKE2b-256 0033a05c08cf72899f7af466335df337eab48168c77ed1c0e99202243cc8dba8

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for vortex_data-0.43.0-cp310-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 1da09d0bc42006efa63a23cdac7b020a928dae4593be19d05b3e0cd5f07346e9
MD5 e0c1a5ffdf908fa217d3dc2ee947baa0
BLAKE2b-256 b0ebd67cf729e1b96d74db58a244fde940ad24fa8f11431ed95f7c05fba34b1a

See more details on using hashes here.

Provenance

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