Skip to main content

DataFusionEngine

Struct DataFusionEngine 

Source
pub struct DataFusionEngine { /* private fields */ }
Expand description

DataFusion-backed OLAP engine.

Supports pluggable storage via StorageMode:

  • InMemory: stores Arrow data in memory, registers as MemTable
  • ArrowIpc/Parquet: stores data as files on disk, registers as ListingTable
  • S3Parquet/GcsParquet (cloud-storage feature): Parquet files on object storage, registered as ListingTable once the object store is wired into the SessionContext

Implementations§

Source§

impl DataFusionEngine

Source

pub fn with_storage(mode: StorageMode) -> Result<DataFusionEngine, DfOlapError>

Create a new DataFusion engine with the given storage mode.

For file-backed modes, creates the base directory if it doesn’t exist and scans for existing data files to initialize the file counter (avoiding overwrites on restart).

For cloud modes (S3Parquet / GcsParquet, requires the cloud-storage feature), registers the appropriate object_store implementation with the DataFusion SessionContext. Credentials are resolved from the environment at construction time.

Source

pub fn new() -> DataFusionEngine

Create a new in-memory DataFusion engine (default).

Source

pub fn storage_mode(&self) -> &StorageMode

Returns the storage mode of this engine.

Trait Implementations§

Source§

impl Default for DataFusionEngine

Source§

fn default() -> DataFusionEngine

Returns the “default value” for a type. Read more
Source§

impl OlapEngine for DataFusionEngine

Source§

type Error = DfOlapError

Engine-specific error type returned by all fallible methods.
Source§

async fn query( &self, sql: &str, ) -> Result<Vec<RecordBatch>, <DataFusionEngine as OlapEngine>::Error>

Execute an analytical SQL query and return results as Arrow RecordBatches buffered in memory. Read more
Source§

async fn query_stream( &self, sql: &str, ) -> Result<Pin<Box<dyn Stream<Item = Result<RecordBatch, Box<dyn Error + Send + Sync>>> + Send>>, <DataFusionEngine as OlapEngine>::Error>

Execute a SQL query and return a lazy RecordBatchBoxStream. Read more
Source§

async fn execute( &self, sql: &str, ) -> Result<u64, <DataFusionEngine as OlapEngine>::Error>

Execute a DDL or DML statement without returning rows. Read more
Source§

async fn load_arrow( &self, table: &str, batches: &[RecordBatch], ) -> Result<u64, <DataFusionEngine as OlapEngine>::Error>

Bulk-load Arrow RecordBatches into table. Read more
Source§

async fn create_table( &self, table_name: &str, schema: &Arc<Schema>, _primary_key: &[String], ) -> Result<(), <DataFusionEngine as OlapEngine>::Error>

Create a table from an Arrow schema with an optional primary key. Read more
Source§

async fn table_exists( &self, table_name: &str, ) -> Result<bool, <DataFusionEngine as OlapEngine>::Error>

Return true if table_name exists in the OLAP catalog. Read more
Source§

async fn add_column( &self, table_name: &str, column_name: &str, data_type: &DataType, ) -> Result<(), <DataFusionEngine as OlapEngine>::Error>

Add a nullable column to an existing table. Read more
Source§

async fn drop_column( &self, table_name: &str, column_name: &str, ) -> Result<(), <DataFusionEngine as OlapEngine>::Error>

Remove a column from an existing table. Read more
Source§

fn supports_transactions(&self) -> bool

Returns true if this backend supports ACID transactions via BEGIN / COMMIT / ROLLBACK. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more