Skip to content

Latest commit

 

History

History
138 lines (104 loc) · 6.81 KB

README.md

File metadata and controls

138 lines (104 loc) · 6.81 KB
Raw

Apache DataFusion

Crates.io Apache licensed Build Status Discord chat

Website | API Docs | Chat

logo

DataFusion is an extensible query engine written in Rust that uses Apache Arrow as its in-memory format.

The DataFusion libraries in this repository are used to build data-centric system software. DataFusion also provides the following subprojects, which are packaged versions of DataFusion intended for end users.

  • DataFusion Python offers a Python interface for SQL and DataFrame queries.
  • DataFusion Ray provides a distributed version of DataFusion that scales out on Ray clusters.
  • DataFusion Comet is an accelerator for Apache Spark based on DataFusion.

The target audience for the DataFusion crates in this repository are developers building fast and feature rich database and analytic systems, customized to particular workloads. See use cases for examples.

DataFusion offers [SQL] and [Dataframe] APIs, excellent performance, built-in support for CSV, Parquet, JSON, and Avro, extensive customization, and a great community.

DataFusion features a full query planner, a columnar, streaming, multi-threaded, vectorized execution engine, and partitioned data sources. You can customize DataFusion at almost all points including additional data sources, query languages, functions, custom operators and more. See the Architecture section for more details.

Here are links to some important information

What can you do with this crate?

DataFusion is great for building projects such as domain specific query engines, new database platforms and data pipelines, query languages and more. It lets you start quickly from a fully working engine, and then customize those features specific to your use. Click Here to see a list known users.

Contributing to DataFusion

Please see the contributor guide and communication pages for more information.

Crate features

This crate has several features which can be specified in your Cargo.toml.

Default features:

  • nested_expressions: functions for working with nested type function such as array_to_string
  • compression: reading files compressed with xz2, bzip2, flate2, and zstd
  • crypto_expressions: cryptographic functions such as md5 and sha256
  • datetime_expressions: date and time functions such as to_timestamp
  • encoding_expressions: encode and decode functions
  • parquet: support for reading the Apache Parquet format
  • regex_expressions: regular expression functions, such as regexp_match
  • unicode_expressions: Include unicode aware functions such as character_length
  • unparser : enables support to reverse LogicalPlans back into SQL

Optional features:

  • avro: support for reading the Apache Avro format
  • backtrace: include backtrace information in error messages
  • pyarrow: conversions between PyArrow and DataFusion types
  • serde: enable arrow-schema's serde feature

Rust Version Compatibility Policy

DataFusion's Minimum Required Stable Rust Version (MSRV) policy is to support stable 4 latest Rust versions OR the stable minor Rust version as of 4 months, whichever is lower.

For example, given the releases 1.78.0, 1.79.0, 1.80.0, 1.80.1 and 1.81.0 DataFusion will support 1.78.0, which is 3 minor versions prior to the most minor recent 1.81.

If a hotfix is released for the minimum supported Rust version (MSRV), the MSRV will be the minor version with all hotfixes, even if it surpasses the four-month window.

We enforce this policy using a MSRV CI Check