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 default VortexTableOptions. Those defaults are copied into the formats and sources created for each table.

Example

use std::sync::Arc;

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

let factory = Arc::new(VortexFormatFactory::new().with_options(VortexTableOptions {
    projection_pushdown: true,
    ..Default::default()
}));

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 default options.

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

Creates a factory with an explicit session and default options.

The supplied options become the baseline for every VortexFormat created by this factory. DataFusion may still override them with table-level options passed into FileFormatFactory::create.

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

Overrides the default options for this factory.

This is the usual way to turn on features such as projection pushdown for every table created through the factory.

Example

use vortex_datafusion::{VortexFormatFactory, VortexTableOptions};

let factory = VortexFormatFactory::new().with_options(VortexTableOptions {
    projection_pushdown: true,
    ..Default::default()
});

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

fn as_any(&self) -> &dyn Any

Returns the table source as Any so that it can be downcast to a specific implementation.

impl GetExt for VortexFormatFactory

fn get_ext(&self) -> String

File extension getter