vortex-datafusion 0.70.0

Apache Datafusion integration for Vortex
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

// SPDX-License-Identifier: Apache-2.0
// SPDX-FileCopyrightText: Copyright the Vortex contributors

//! File-backed DataFusion integration for `.vortex` files.
//!
//! Use this module when Vortex data lives in a filesystem or object store and
//! you want DataFusion to discover files, infer schema, and build
//! [`DataSourceExec`] plans for you.
//!
//! The main entry points are:
//!
//! - [`VortexFormatFactory`] to register the `vortex` file format with
//!   DataFusion.
//! - [`VortexFormat`] when constructing
//!   [`ListingOptions`] directly.
//! - [`VortexSource`] for lower-level `FileScanConfig` construction.
//! - [`VortexAccessPlan`] when external indexing or custom file selection needs
//!   to restrict what a scan reads.
//! - [`metrics::VortexMetricsFinder`] to collect Vortex-specific scan metrics
//!   from a planned query.
//!
//! [`DataSourceExec`]: datafusion_datasource::source::DataSourceExec
//! [`ListingOptions`]: https://docs.rs/datafusion/latest/datafusion/datasource/listing/struct.ListingOptions.html

mod access_plan;
mod cache;
mod format;
pub mod metrics;
mod opener;
pub mod reader;
mod sink;
mod source;
mod stream;

pub use access_plan::VortexAccessPlan;
pub use format::VortexFormat;
pub use format::VortexFormatFactory;
pub use format::VortexTableOptions;
pub use source::VortexSource;

#[cfg(test)]
mod tests;