polars_pipe::pipeline

Struct PipeLine

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

A pipeline consists of:

    1. One or more sources. Sources get pulled and their data is pushed into operators.
    1. Zero or more operators. The operators simply pass through data, modifying it as they need. Operators can work on batches and don’t need all data in scope to succeed. Think for example on multiply a few columns, or applying a predicate. Operators can shrink the batches: filter Grow the batches: explode/ unpivot Keep them the same size: element-wise operations The probe side of join operations is also an operator.
    1. One or more sinks A sink needs all data in scope to finalize a pipeline branch. Think of sorts, preparing a build phase of a join, group_by + aggregations.

This struct will have the SOS (source, operators, sinks) of its own pipeline branch, but also the SOS of other branches. The SOS are stored data oriented and the sinks have an offset that indicates the last operator node before that specific sink. We only store the end offset and keep track of the starting operator during execution.

Pipelines branches are shared with other pipeline branches at the join/union nodes.

§JOIN

Consider this tree: out / /
1 2

And let’s consider that branch 2 runs first. It will run until the join node where it will sink into a build table. Once that is done it will replace the build-phase placeholder operator in branch 1. Branch one can then run completely until out.

Implementations§

Source§

impl PipeLine

Source

pub fn run_pipeline( &mut self, ec: &PExecutionContext, pipelines: &mut Vec<PipeLine>, ) -> PolarsResult<Option<FinalizedSink>>

Run a single pipeline branch. This pulls data from the sources and pushes it into the operators which run on a different thread and finalize in a sink.

The sink can be finished, but can also become a new source and then rinse and repeat.

Trait Implementations§

Source§

impl Debug for PipeLine

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Send for PipeLine

Source§

impl Sync for PipeLine

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, 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> Pointable for T

Source§

const ALIGN: usize = _

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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.
Source§

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

Source§

fn vzip(self) -> V