Struct VortexFormatFactory 

pub struct VortexFormatFactory { /* private fields */ }

Registration entry point for the file-backed Vortex integration.

VortexFormatFactory is the type most applications use. Register it with a DataFusion session, and DataFusion will create VortexFormat values for CREATE EXTERNAL TABLE, ListingTable, and URL-table scans.

The factory stores a VortexSession and optional factory-level VortexTableOptions. When options are set on the factory they act like customized format defaults, matching DataFusion’s Parquet and JSON factory APIs. Otherwise, VortexFormatFactory::create uses the session’s vortex options. In both cases, table OPTIONS(...) are applied last for the table being created.

Example

use std::sync::Arc;

use datafusion::datasource::provider::DefaultTableFactory;
use datafusion::execution::SessionStateBuilder;
use datafusion_common::GetExt;
use vortex_datafusion::{VortexFormatFactory, VortexTableOptions};

let mut options = VortexTableOptions::default();
options.predicate_pushdown = true;
options.projection_pushdown = true;

let factory = Arc::new(VortexFormatFactory::new().with_options(options));

let mut state_builder = SessionStateBuilder::new()
    .with_default_features()
    .with_table_factory(
        factory.get_ext().to_uppercase(),
        Arc::new(DefaultTableFactory::new()),
    );

if let Some(file_formats) = state_builder.file_formats() {
    file_formats.push(factory.clone() as _);
}

Implementations

impl VortexFormatFactory

pub fn new() -> Self

Creates a factory with a default VortexSession and no factory-level options.

Formats created by this factory start from the session’s vortex options, or from VortexTableOptions::default if the session does not contain them. Table-level OPTIONS(...) are still applied last.

pub fn new_with_options( session: VortexSession, options: VortexTableOptions, ) -> Self

Creates a factory with an explicit session and factory-level options.

The supplied options become the complete starting value for every VortexFormat created by this factory. Session SET vortex.* values are ignored for these formats, matching DataFusion’s built-in new_with_options factories. Table-level OPTIONS(...) are still applied last.

pub fn with_options(self, options: VortexTableOptions) -> Self

Sets factory-level options.

This is the usual way to customize Vortex defaults for every table created through the factory. These options replace, rather than merge with, session SET vortex.* values. Table-level OPTIONS(...) are still applied last.

Example

use vortex_datafusion::{VortexFormatFactory, VortexTableOptions};

let mut options = VortexTableOptions::default();
options.predicate_pushdown = true;
options.projection_pushdown = true;

let factory = VortexFormatFactory::new().with_options(options);

Trait Implementations

impl Debug for VortexFormatFactory

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FileFormatFactory for VortexFormatFactory

fn create( &self, state: &dyn Session, format_options: &HashMap<String, String>, ) -> DFResult<Arc<dyn FileFormat>>

Initialize a FileFormat and configure based on session and command level options

fn default(&self) -> Arc<dyn FileFormat>

Initialize a FileFormat with all options set to default values

impl GetExt for VortexFormatFactory

fn get_ext(&self) -> String

File extension getter