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

Join the community on Slack! | 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

    • 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 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 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! 🚀

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.57.0rc0-cp311-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (10.7 MB view details)

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

vortex_data-0.57.0rc0-cp311-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (10.1 MB view details)

Uploaded CPython 3.11+manylinux: glibc 2.17+ ARM64

vortex_data-0.57.0rc0-cp311-abi3-macosx_11_0_arm64.whl (11.0 MB view details)

Uploaded CPython 3.11+macOS 11.0+ ARM64

vortex_data-0.57.0rc0-cp311-abi3-macosx_10_12_x86_64.whl (11.5 MB view details)

Uploaded CPython 3.11+macOS 10.12+ x86-64

File details

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

File metadata

File hashes

Hashes for vortex_data-0.57.0rc0-cp311-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 c8777a151254d4cc87ad07998cab743552d0b0dd4664419fcf40dcbee4df87af
MD5 60af2668be0028525395d199246762de
BLAKE2b-256 2af0f615f565acddaaad59a9f654ed17af121f0be05218fb60670d46f94fc8b9

See more details on using hashes here.

Provenance

The following attestation bundles were made for vortex_data-0.57.0rc0-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.57.0rc0-cp311-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl.

File metadata

File hashes

Hashes for vortex_data-0.57.0rc0-cp311-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 2f226345e07712825a83d783a7c28cb4aadf4f45e95ad598704ef5862bb7ad1c
MD5 585802a0c69bbd90775989930d27de74
BLAKE2b-256 cf86d641763dda67d504353f12edf0f4d612df47f75bb8d86c6f50576c7efc2f

See more details on using hashes here.

Provenance

The following attestation bundles were made for vortex_data-0.57.0rc0-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.57.0rc0-cp311-abi3-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for vortex_data-0.57.0rc0-cp311-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 9398509a9ca58ea55ec79efea62c7a6817c231f9b33655e4a20785955cb607ab
MD5 2c78f3bccff3319677ba5cfcfd6aa323
BLAKE2b-256 460fd5981738f19c6d044b92e3a094f8a642cf8659970270faf573f4fa0945cc

See more details on using hashes here.

Provenance

The following attestation bundles were made for vortex_data-0.57.0rc0-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.57.0rc0-cp311-abi3-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for vortex_data-0.57.0rc0-cp311-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 b5daa3b501d8e28b4aabf68cbee4fac438ea70ceb9ee17e8f1ea0bfa8bf8c4e1
MD5 55fb665c56c366d2c7f326952f8fd283
BLAKE2b-256 b45d19bcd4111ce3e92e569e4d651b9c250307d67b26d0c4eb669810db82e13b

See more details on using hashes here.

Provenance

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

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