Skip to main content

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

Reason this release was yanked:

Renamed to vortex-data

Project description

🌪️ Vortex

Build Status Crates.io Documentation PyPI - Python Version

📚 Documentation | 📊 Performance Benchmarks

Overview

Vortex is a next-generation columnar file format and toolkit designed for high-performance data analytics. It provides:

  • ⚡️ Blazing Fast Performance

    • 100-200x faster random access reads than Apache Parquet
    • 2-10x faster scans with similar compression ratios and write throughput
    • Efficient support for wide tables with zero-copy/zero-parse metadata
  • 🔧 Extensible Architecture

    • Modeled after Apache DataFusion's extensible approach
    • Pluggable encoding system
    • Zero-copy compatibility with Apache Arrow

🚧 Development Status: This project is under active development. APIs and file formats may change, and some features are still being implemented.

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-array

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, use MiMalloc:

#[global_allocator]
static GLOBAL_ALLOC: MiMalloc = MiMalloc;

Project Information

License

Licensed under the Apache License, Version 2.0

Governance

Vortex is committed to remaining open-source, following governance models inspired by the Substrait project and Apache Software Foundation.

Contributing

See CONTRIBUTING.md for guidelines.

Acknowledgments 🏆

This project builds upon groundbreaking work from the academic and open-source communities:

Key Research Papers

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 Distribution

vortex_array-0.32.0.tar.gz (674.1 kB view details)

Uploaded Source

Built Distributions

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

vortex_array-0.32.0-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (9.4 MB view details)

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

vortex_array-0.32.0-cp310-abi3-macosx_11_0_arm64.whl (9.4 MB view details)

Uploaded CPython 3.10+macOS 11.0+ ARM64

vortex_array-0.32.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_array-0.32.0.tar.gz.

File metadata

  • Download URL: vortex_array-0.32.0.tar.gz
  • Upload date:
  • Size: 674.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for vortex_array-0.32.0.tar.gz
Algorithm Hash digest
SHA256 6cf49cb7980e4fa80467e97ebf5f2c34d0dbb286ef9e237a933672bfa451ff10
MD5 febb470ae8565d054e173125377e2393
BLAKE2b-256 de07de640780ed03f604a4ad9707a41738211c41bc34096a9b84ea2bbe8d13db

See more details on using hashes here.

Provenance

The following attestation bundles were made for vortex_array-0.32.0.tar.gz:

Publisher: release-plz.yml on spiraldb/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_array-0.32.0-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for vortex_array-0.32.0-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 1a48b446dc0650524db0326ae2f693fd780610bb4b595f8ce50902d4c3724f8e
MD5 5ca2c826306b91188554006aefa0f83f
BLAKE2b-256 3663bc8afe545f3a5d3d4e137c07b61b999c22308a88bcd6c4d6cdcb01c49864

See more details on using hashes here.

Provenance

The following attestation bundles were made for vortex_array-0.32.0-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl:

Publisher: release-plz.yml on spiraldb/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_array-0.32.0-cp310-abi3-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for vortex_array-0.32.0-cp310-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 51c83d0eb007c211e08edae85cda62c3776222a87f987f6cfd9a6a16d040ae43
MD5 da8eefdd84cf5bd8d8bba87670c38f1b
BLAKE2b-256 af41298a947be341ce4597327db15465e2c6a0a2f0c7d499cd3109f96c1120ae

See more details on using hashes here.

Provenance

The following attestation bundles were made for vortex_array-0.32.0-cp310-abi3-macosx_11_0_arm64.whl:

Publisher: release-plz.yml on spiraldb/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_array-0.32.0-cp310-abi3-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for vortex_array-0.32.0-cp310-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 729fd06326067c3c0d98850fb0cb33d72f486c1e215da1e7369ea96425ef6bd9
MD5 bb888385d6b3c60be64fa94436c178ad
BLAKE2b-256 9b623ec75e2df311ecdbce7ab1541fec64913631333be1089d4aebec92876a4e

See more details on using hashes here.

Provenance

The following attestation bundles were made for vortex_array-0.32.0-cp310-abi3-macosx_10_12_x86_64.whl:

Publisher: release-plz.yml on spiraldb/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