Skip to main content

QueryEngine

Struct QueryEngine 

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

High-performance SQL query engine powered by Apache DataFusion

The QueryEngine manages a DataFusion SessionContext and provides methods for registering data files and executing SQL queries with zero-copy streaming.

Implementations§

Source§

impl QueryEngine

Source

pub fn new() -> Result<Self>

Create a new query engine with default configuration

§Errors

Returns an error if the session context cannot be initialized

Source

pub async fn register_file( &mut self, file_path: &str, table_name: &str, ) -> Result<()>

Register a CSV or JSON file as a table in the query engine

The file format is automatically detected from the file extension. Supported formats: .csv, .json

§Arguments
  • file_path - Path to the data file
  • table_name - Name to use for the table in SQL queries
§Errors

Returns an error if:

  • The file does not exist
  • The file format is unsupported
  • Schema inference fails
  • Table registration fails
Source

pub async fn execute_query(&self, sql: &str) -> Result<DataFrame>

Execute a SQL query and return the results as a DataFrame

§Arguments
  • sql - SQL query string to execute
§Errors

Returns an error if query parsing or execution fails

Source

pub async fn print_results(&self, dataframe: DataFrame) -> Result<()>

Execute a SQL query and print the results to stdout

Uses Arrow’s pretty printer for formatted table output with streaming to handle large result sets efficiently.

§Arguments
  • dataframe - The DataFrame to print
§Errors

Returns an error if result collection or printing fails

Trait Implementations§

Source§

impl Default for QueryEngine

Source§

fn default() -> Self

Returns the “default value” for a type. 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