Lib.rs

› Development tools › Testing › Arrow
#apache-arrow #json #arrow #json-format #integration-tests #columnar #data-integration

arrow-integration-test

Support for the Apache Arrow JSON test data format

by Raphael Taylor-Davies, Andrew Lamb, Krisztián Szűcs, Sutou Kouhei, Wakahisa, Andy Grove, Uwe L. Korn and 92 contributors

28 major breaking releases

53.2.0 Oct 24, 2024
53.0.0 Sep 3, 2024
52.2.0 Jul 28, 2024
51.0.0 Mar 18, 2024
25.0.0 Oct 17, 2022

#151 in Testing

Download history 5/week @ 2024-07-15 115/week @ 2024-07-22 234/week @ 2024-07-29 99/week @ 2024-08-05 119/week @ 2024-08-12 40/week @ 2024-08-19 65/week @ 2024-08-26 218/week @ 2024-09-02 61/week @ 2024-09-09 127/week @ 2024-09-16 84/week @ 2024-09-23 192/week @ 2024-09-30 147/week @ 2024-10-07 113/week @ 2024-10-14 162/week @ 2024-10-21 77/week @ 2024-10-28

616 downloads per month
Used in chewdata

Apache-2.0

570KB
11K SLoC

Native Rust implementation of Apache Arrow and Apache Parquet

Coverage Status

Welcome to the Rust implementation of Apache Arrow, the popular in-memory columnar format.

This repo contains the following main components:

Crate Description Latest API Docs README
arrow Core functionality (memory layout, arrays, low level computations) docs.rs (README)
arrow-flight Support for Arrow-Flight IPC protocol docs.rs (README)
object-store Support for object store interactions (aws, azure, gcp, local, in-memory) docs.rs (README)
parquet Support for Parquet columnar file format docs.rs (README)
parquet_derive A crate for deriving RecordWriter/RecordReader for arbitrary, simple structs docs.rs (README)

The current development version the API documentation in this repo can be found here.

Release Versioning and Schedule

arrow and parquet crates

The Arrow Rust project releases approximately monthly and follows Semantic Versioning.

Due to available maintainer and testing bandwidth, arrow crates (arrow, arrow-flight, etc.) are released on the same schedule with the same versions as the parquet and parquet-derive crates.

This crate releases every month. We release new major versions (with potentially breaking API changes) at most once a quarter, and release incremental minor versions in the intervening months. See this ticket for more details.

To keep our maintenance burden down, we do regularly scheduled releases (major and minor) from the master branch. How we handle PRs with breaking API changes is described in the contributing guide.

Planned Release Schedule

Approximate Date Version Notes
Sep 2024 53.0.0 Major, potentially breaking API changes
Oct 2024 53.1.0 Minor, NO breaking API changes
Nov 2024 53.2.0 Minor, NO breaking API changes
Dec 2024 54.0.0 Major, potentially breaking API changes

object_store crate

The object_store crate is released independently of the arrow and parquet crates and follows Semantic Versioning. We aim to release new versions approximately every 2 months.

There are several related crates in different repositories

Crate Description Documentation
datafusion In-memory query engine with SQL support (README)
ballista Distributed query execution (README)
object_store_opendal Use opendal as object_store backend (README)
parquet_opendal Use opendal for parquet Arrow IO (README)

Collectively, these crates support a wider array of functionality for analytic computations in Rust.

For example, you can write SQL queries or a DataFrame (using the datafusion crate) to read a parquet file (using the parquet crate), evaluate it in-memory using Arrow's columnar format (using the arrow crate), and send to another process (using the arrow-flight crate).

Generally speaking, the arrow crate offers functionality for using Arrow arrays, and datafusion offers most operations typically found in SQL, including joins and window functions.

You can find more details about each crate in their respective READMEs.

Arrow Rust Community

The dev@arrow.apache.org mailing list serves as the core communication channel for the Arrow community. Instructions for signing up and links to the archives can be found on the Arrow Community page. All major announcements and communications happen there.

The Rust Arrow community also uses the official ASF Slack for informal discussions and coordination. This is a great place to meet other contributors and get guidance on where to contribute. Join us in the #arrow-rust channel and feel free to ask for an invite via:

  1. the dev@arrow.apache.org mailing list
  2. the GitHub Discussions
  3. the Discord channel

The Rust implementation uses GitHub issues as the system of record for new features and bug fixes and this plays a critical role in the release process.

For design discussions we generally collaborate on Google documents and file a GitHub issue linking to the document.

There is more information in the contributing guide.

lib.rs:

Support for the Apache Arrow JSON test data format

These utilities define structs that read the integration JSON format for integration testing purposes.

This is not a canonical format, but provides a human-readable way of verifying language implementations

Dependencies

~13–20MB
~279K SLoC