Struct OxideSession 

pub struct OxideSession { /* private fields */ }

An OxideLake session.

Implementations

impl OxideSession

pub fn local() -> Result<Self, EngineError>

Creates an embedded session: Parquet pruning on, the local object store registered, the SQL UDFs, and the placement rule targeting the detected backend.

pub fn local_with_target(target: BackendKind) -> Result<Self, EngineError>

An embedded session whose placement rule targets target instead of the detected backend. Placement is a planning decision: operators still select the real local backend at execute() time and fall back to the CPU reference, so planning for an absent GPU is safe — it is exactly what cluster executors do with the scheduler’s plans.

pub async fn connect(scheduler_url: &str) -> Result<Self, EngineError>

Connects to a Ballista scheduler (df://host:port). The session carries OxideLake’s plan codec so Gpu*Exec nodes survive the trip to executors, and the SQL UDFs so queries plan client-side; placement itself happens on the scheduler.

pub fn mode(&self) -> &SessionMode

The execution mode.

pub fn ctx(&self) -> &SessionContext

The underlying DataFusion context.

pub fn telemetry(&self) -> &Arc<TelemetryHub>

The telemetry hub for this session (local process only).

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

Plans a SQL statement into a lazily executed DataFrame.

pub async fn register_parquet( &self, name: &str, path: &str, ) -> Result<(), EngineError>

Registers a Parquet file or directory as name.

pub async fn explain(&self, query: &str) -> Result<String, EngineError>

The indented physical plan for query, with placement tags in embedded mode. In cluster mode this is the client-side plan (DistributedQueryExec); the scheduler’s plan is what carries the tags there.

Trait Implementations

impl Debug for OxideSession

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

Formats the value using the given formatter.