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.29.0.tar.gz (647.3 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.29.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_array-0.29.0-cp310-abi3-macosx_11_0_arm64.whl (9.2 MB view details)

Uploaded CPython 3.10+macOS 11.0+ ARM64

vortex_array-0.29.0-cp310-abi3-macosx_10_12_x86_64.whl (10.0 MB view details)

Uploaded CPython 3.10+macOS 10.12+ x86-64

File details

Details for the file vortex_array-0.29.0.tar.gz.

File metadata

  • Download URL: vortex_array-0.29.0.tar.gz
  • Upload date:
  • Size: 647.3 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.29.0.tar.gz
Algorithm Hash digest
SHA256 fde51817b66add53c7238d602c92b165c3792efdeff56949215bccaf498aa91b
MD5 7975f5d474ff88ee78ca5b4e67988e78
BLAKE2b-256 3f82cbed251a2f524d4da965702cdb67b93b90214ba4964b586162af4a5be736

See more details on using hashes here.

Provenance

The following attestation bundles were made for vortex_array-0.29.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.29.0-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for vortex_array-0.29.0-cp310-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 2a99c5cb405573954a46e4c9396bc709d33a48ef79625f311214375244c57f1b
MD5 9ec427a951dd708b595384a9f98f144c
BLAKE2b-256 c743902d6d4dfe60eae5aa0cb3b6e6aed9fb55202d0ded7188cc2db2903df862

See more details on using hashes here.

Provenance

The following attestation bundles were made for vortex_array-0.29.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.29.0-cp310-abi3-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for vortex_array-0.29.0-cp310-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 93a4a930ca8818d626d1e404e491b7491d6d9b277c36b19e2ba099487eb4cb1f
MD5 32adb87920c3c3f9aa0c77f0523dc9d9
BLAKE2b-256 87615f2226185ed52d4f100f1d1c2a4dac436215bfc2bcc7774e495abc0afef1

See more details on using hashes here.

Provenance

The following attestation bundles were made for vortex_array-0.29.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.29.0-cp310-abi3-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for vortex_array-0.29.0-cp310-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 3c563cd1d669485dbdf97485335614827cd60f9bfc150b7a16cc8db4c2b68963
MD5 2193d986664a3184c870067073ce47be
BLAKE2b-256 c0eb31e3281d3e7578f329ca25046c4ff5846c06898b88cce1b741b90dd8200c

See more details on using hashes here.

Provenance

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