Struct OxideFrame 

pub struct OxideFrame { /* private fields */ }

A lazily built query over one session, collected with Self::collect.

Implementations

impl OxideFrame

pub fn new(inner: DataFrame) -> Self

Wraps a DataFusion DataFrame.

pub fn into_inner(self) -> DataFrame

The underlying DataFusion DataFrame, for verbs this API does not wrap.

pub fn schema(&self) -> SchemaRef

The frame’s Arrow schema.

pub fn filter(self, predicate: Expr) -> Result<Self, EngineError>

Keeps rows matching predicate (e.g. col("k").gt_eq(lit(2))).

pub fn select(self, columns: &[&str]) -> Result<Self, EngineError>

Keeps the named columns, in order.

pub fn alias(self, name: &str) -> Result<Self, EngineError>

Renames the frame’s table qualifier (required to self-join a table).

pub fn join( self, right: OxideFrame, left_key: &str, right_key: &str, ) -> Result<Self, EngineError>

Inner-joins right on left_key = right_key.

pub fn aggregate( self, group_by: Vec<Expr>, aggregates: Vec<Expr>, ) -> Result<Self, EngineError>

Groups by group_by and computes aggregates (e.g. aggregate(vec![col("k")], vec![sum(col("v"))])).

pub fn sort(self, exprs: Vec<SortExpr>) -> Result<Self, EngineError>

Sorts by expr (e.g. col("d").sort(true, false) for ascending).

pub fn limit(self, n: usize) -> Result<Self, EngineError>

Keeps at most n rows.

pub fn vector_distance( self, column: &str, query: &[f32], metric: DistanceMetric, output: &str, ) -> Result<Self, EngineError>

Appends output — the metric distance between the vector column column (FixedSizeList<Float32>) and query — as a nullable Float32 column. Plans the l2_distance / cosine_distance UDF, so a GPU-target session lowers it to GpuVectorDistanceExec.

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

The indented physical plan, with placement tags on Gpu*Exec nodes.

pub async fn collect(self) -> Result<Vec<RecordBatch>, EngineError>

Executes the frame and returns every batch.

pub async fn show(self) -> Result<(), EngineError>

Executes the frame and prints it as a table.

Trait Implementations

impl Clone for OxideFrame

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OxideFrame

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

Formats the value using the given formatter.

impl From<DataFrame> for OxideFrame

fn from(inner: DataFrame) -> Self

Converts to this type from the input type.