Struct VortexFormat 

pub struct VortexFormat { /* private fields */ }

Vortex implementation of a DataFusion FileFormat.

Implementations

impl VortexFormat

pub fn new(session: Arc<VortexSession>) -> Self

Create a new instance with default options.

pub fn new_with_options( session: Arc<VortexSession>, opts: VortexOptions, ) -> Self

Creates a new instance with configured by a VortexOptions.

pub fn options(&self) -> &VortexOptions

Return the format specific configuration

Trait Implementations

impl Debug for VortexFormat

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

Formats the value using the given formatter.

impl Default for VortexFormat

fn default() -> Self

Returns the “default value” for a type.

impl FileFormat for VortexFormat

fn as_any(&self) -> &dyn Any

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

fn compression_type(&self) -> Option<FileCompressionType>

Returns whether this instance uses compression if applicable

fn get_ext(&self) -> String

Returns the extension for this FileFormat, e.g. “file.csv” -> csv

fn get_ext_with_compression( &self, file_compression_type: &FileCompressionType, ) -> DFResult<String>

Returns the extension for this FileFormat when compressed, e.g. “file.csv.gz” -> csv

fn infer_schema<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, state: &'life1 dyn Session, store: &'life2 Arc<dyn ObjectStore>, objects: &'life3 [ObjectMeta], ) -> Pin<Box<dyn Future<Output = DFResult<SchemaRef>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Infer the common schema of the provided objects. The objects will usually be analysed up to a given number of records or files (as specified in the format config) then give the estimated common schema. This might fail if the files have schemas that cannot be merged.

fn infer_stats<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, _state: &'life1 dyn Session, store: &'life2 Arc<dyn ObjectStore>, table_schema: SchemaRef, object: &'life3 ObjectMeta, ) -> Pin<Box<dyn Future<Output = DFResult<Statistics>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Infer the statistics for the provided object. The cost and accuracy of the estimated statistics might vary greatly between file formats.

fn create_physical_plan<'life0, 'life1, 'async_trait>( &'life0 self, _state: &'life1 dyn Session, file_scan_config: FileScanConfig, ) -> Pin<Box<dyn Future<Output = DFResult<Arc<dyn ExecutionPlan>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Take a list of files and convert it to the appropriate executor according to this file format.

fn create_writer_physical_plan<'life0, 'life1, 'async_trait>( &'life0 self, input: Arc<dyn ExecutionPlan>, _state: &'life1 dyn Session, conf: FileSinkConfig, order_requirements: Option<LexRequirement>, ) -> Pin<Box<dyn Future<Output = DFResult<Arc<dyn ExecutionPlan>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Take a list of files and the configuration to convert it to the appropriate writer executor according to this file format.

fn file_source(&self) -> Arc<dyn FileSource>

Return the related FileSource such as CsvSource, JsonSource, etc.