Skip to main content

TableBuilder

Struct TableBuilder 

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

Generic columnar table builder. Implements ColumnarSink so any decoder can feed it field/value events; at the end it produces an Arrow RecordBatch.

Implementations§

Source§

impl TableBuilder

Source

pub fn new() -> Self

Source

pub fn with_capacity(cap: usize) -> Self

Source

pub fn with_plan(cap: usize, plan: ExecutionPlan) -> Self

Source

pub fn num_rows(&self) -> usize

Source

pub fn num_columns(&self) -> usize

Source

pub fn column_names(&self) -> &[String]

Source

pub fn finish(&mut self) -> Result<RecordBatch>

Finalize the builder into an Arrow RecordBatch.

This is also available as the ColumnarSink::finish trait method.

Source

pub fn reset(&mut self)

Reset all data while preserving the plan and estimated rows.

Source

pub fn normalize(&mut self)

Truncate every column back to row_count, dropping any partial-row values from a mid-field EOF. Idempotent.

Source

pub fn auto_dict_upgrade(&mut self)

If auto_dict is set, upgrade low-cardinality string columns.

Source

pub fn sort_columns(&mut self)

Sort columns according to schema_order. Columns named in schema_order appear in that order; any other columns keep their relative first-appearance order after the ordered ones.

Source§

impl TableBuilder

Source

pub fn extend(&mut self, other: TableBuilder) -> Result<()>

Merge another builder’s data into this one, consuming other.

New columns discovered in other are null-padded for the existing rows in self. Columns present in self but absent from other are null-padded for other’s rows. Column order follows first-appearance order across both builders.

Trait Implementations§

Source§

impl ColumnarSink for TableBuilder

Source§

fn begin_row(&mut self)

Source§

fn put_field(&mut self, name: &str, value: Value<'_>)

Source§

fn end_row(&mut self)

Source§

fn wants(&self, name: &str) -> bool

Return false to signal that the engine will drop this field.
Source§

fn finish(&mut self) -> Result<RecordBatch>

Finalize the sink into an Arrow RecordBatch.
Source§

impl Default for TableBuilder

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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.