Struct RecordBatch 

pub struct RecordBatch { /* private fields */ }

A batch of rows, as Arrow columns.

Implementations

impl RecordBatch

pub fn of(chunk: &Chunk, names: &[String]) -> Result<Self>

The batch a chunk becomes, with these column names.

The names come from the caller because a chunk does not have any. A chunk is a run of vectors and the names live on whatever produced it, which for a query result is the plan’s output list and for a table scan is the catalog.

Errors

When the number of names is not the number of columns, and for anything Array::of rejects.

pub fn empty(schema: Schema) -> Result<Self>

An empty batch of this schema.

A result with no rows still has columns, and a consumer that reads the schema off the first batch needs one to read it off. Every array in it has length zero, which is a validity bitmap of nothing and a values buffer of nothing.

Errors

Never, today. It returns a result so that a schema carrying a type with no empty array later has somewhere to say so.

pub fn schema(&self) -> &Schema

The columns and their names.

pub fn len(&self) -> usize

How many rows.

pub fn is_empty(&self) -> bool

Whether there are none.

pub fn width(&self) -> usize

How many columns.

pub fn columns(&self) -> &[Array]

The columns, left to right.

pub fn column(&self, index: usize) -> Option<&Array>

One column, by position.

Trait Implementations

impl Clone for RecordBatch

fn clone(&self) -> RecordBatch

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RecordBatch

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

Formats the value using the given formatter.

impl Eq for RecordBatch

impl PartialEq for RecordBatch

fn eq(&self, other: &RecordBatch) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for RecordBatch