Struct RecordBatch 

pub struct RecordBatch {
    pub schema: SchemaRef,
    df_record_batch: DfRecordBatch,
}

A two-dimensional batch of column-oriented data with a defined schema.

Fields

schema: SchemaRef

df_record_batch: DfRecordBatch

Implementations

impl RecordBatch

pub fn new<I: IntoIterator<Item = VectorRef>>( schema: SchemaRef, columns: I, ) -> Result<RecordBatch>

Create a new RecordBatch from schema and columns.

fn cast_view_arrays( schema: &ArrowSchemaRef, arrays: Vec<ArrayRef>, ) -> Result<Vec<ArrayRef>>

pub fn new_empty(schema: SchemaRef) -> RecordBatch

Create an empty RecordBatch from schema.

pub fn new_with_count(schema: SchemaRef, num_rows: usize) -> Result<Self>

Create an empty RecordBatch from schema with num_rows.

pub fn try_project(&self, indices: &[usize]) -> Result<Self>

pub fn from_df_record_batch( schema: SchemaRef, df_record_batch: DfRecordBatch, ) -> RecordBatch

Create a new RecordBatch from schema and df_record_batch.

This method doesn’t check the schema.

pub fn df_record_batch(&self) -> &DfRecordBatch

pub fn into_df_record_batch(self) -> DfRecordBatch

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

pub fn column(&self, idx: usize) -> &ArrayRef

pub fn column_by_name(&self, name: &str) -> Option<&ArrayRef>

pub fn num_columns(&self) -> usize

pub fn num_rows(&self) -> usize

pub fn column_vectors( &self, table_name: &str, table_schema: SchemaRef, ) -> Result<HashMap<String, VectorRef>>

pub fn pretty_print(&self) -> String

Pretty display this record batch like a table

pub fn slice(&self, offset: usize, len: usize) -> Result<RecordBatch>

Return a slice record batch starts from offset, with len rows

pub fn buffer_memory_size(&self) -> usize

Returns the total number of bytes of memory pointed to by the arrays in this RecordBatch.

The buffers store bytes in the Arrow memory format, and include the data as well as the validity map. Note that this does not always correspond to the exact memory usage of an array, since multiple arrays can share the same buffers or slices thereof.

pub fn iter_column_as_string( &self, i: usize, ) -> Box<dyn Iterator<Item = Option<String>> + '_>

Iterate the values as strings in the column at index i.

Note that if the underlying array is not a valid GreptimeDB vector, an empty iterator is returned.

Panics

if index i is out of bound.

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 PartialEq for RecordBatch

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for RecordBatch

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RecordBatch