Skip to main content

LazyFrame

Struct LazyFrame 

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

Lazy query API (LazyFrame, LazyGroupBy). A lazily-evaluated query backed by a LogicalPlan.

Implementations§

Source§

impl LazyFrame

Source

pub fn from_dataframe(df: DataFrame) -> Self

Create a LazyFrame that scans an in-memory DataFrame.

Source

pub fn scan_csv(path: impl AsRef<Path>) -> Result<Self>

Build a CSV scan plan (no file I/O is performed until collect()).

Source

pub fn scan_parquet(path: impl AsRef<Path>) -> Result<Self>

Build a Parquet scan plan (no file I/O is performed until collect()).

Source

pub fn select(self, exprs: Vec<Expr>) -> Self

Add a projection (select) node to the logical plan.

Source

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

Add a filter node to the logical plan.

Source

pub fn with_columns(self, exprs: Vec<Expr>) -> Self

Add a projection (with_columns) node to the logical plan.

Source

pub fn group_by(self, by: Vec<Expr>) -> LazyGroupBy

Start a group-by on this LazyFrame.

Source

pub fn join<K: Into<JoinKeys>>( self, other: LazyFrame, keys: K, how: JoinType, ) -> Self

Join with another LazyFrame using provided join keys.

Source

pub fn sort(self, options: SortOptions) -> Self

Sort by one or more columns.

Source

pub fn head(self, n: usize) -> Self

Return the first n rows.

Source

pub fn tail(self, n: usize) -> Self

Return the last n rows.

Source

pub fn unique(self, subset: Option<Vec<String>>) -> Self

Remove duplicate rows.

Source

pub fn fill_null<T: Into<FillNull>>(self, fill: T) -> Self

Fill null values using a scalar or strategy.

Source

pub fn drop_nulls(self, subset: Option<Vec<String>>) -> Self

Drop rows containing null values.

Source

pub fn null_count(self) -> Self

Count null values per column.

Source

pub fn collect(self) -> Result<DataFrame>

Optimize, compile, and execute this LazyFrame into an eager DataFrame.

Source

pub fn explain(self, optimized: bool) -> String

Render the logical plan as a human-readable string.

If optimized is true, includes optimizer rewrites such as pushdowns.

Trait Implementations§

Source§

impl Clone for LazyFrame

Source§

fn clone(&self) -> LazyFrame

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for LazyFrame

Source§

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

Formats the value using the given formatter. 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.