Struct DataTable 

pub struct DataTable { /* private fields */ }

A columnar data table backed by Arrow RecordBatch.

DataTable wraps an Arrow RecordBatch and provides typed column access, zero-copy slicing, and interop with the Shape type system.

Implementations

impl DataTable

pub fn new(batch: RecordBatch) -> Self

Create a new DataTable from an Arrow RecordBatch.

pub fn with_type_name(batch: RecordBatch, type_name: String) -> Self

Create a new DataTable with an associated type name.

pub fn with_schema_id(self, schema_id: u32) -> Self

Set the schema ID for typed table access.

pub fn with_index_col(self, name: String) -> Self

Set the index column name (from index_by()).

pub fn set_origin(&mut self, source: ValueWord, params: ValueWord)

Set the origin (source, params) from the load() call that created this table.

pub fn origin(&self) -> ValueWord

Get the origin as a structured TypedObject { source, params }. Returns ValueWord::none() if no origin is set.

pub fn schema_id(&self) -> Option<u32>

Get the schema ID if this is a typed table.

pub fn index_col(&self) -> Option<&str>

Get the index column name if set.

pub fn column_ptr(&self, index: usize) -> Option<&ColumnPtrs>

Get column pointers for a column by index.

pub fn column_ptrs(&self) -> &[ColumnPtrs]

Get all column pointers.

pub fn row_count(&self) -> usize

Number of rows in the table.

pub fn column_count(&self) -> usize

Number of columns in the table.

pub fn column_names(&self) -> Vec<String>

Column names in order.

pub fn schema(&self) -> Arc<Schema>

The Arrow schema.

pub fn type_name(&self) -> Option<&str>

The optional Shape type name.

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

Get a column by name as a generic ArrayRef.

pub fn get_f64_column(&self, name: &str) -> Option<&Float64Array>

Get a Float64 column by name.

pub fn get_i64_column(&self, name: &str) -> Option<&Int64Array>

Get an Int64 column by name.

pub fn get_string_column(&self, name: &str) -> Option<&StringArray>

Get a String (Utf8) column by name.

pub fn get_bool_column(&self, name: &str) -> Option<&BooleanArray>

Get a Boolean column by name.

pub fn get_timestamp_column( &self, name: &str, ) -> Option<&TimestampMicrosecondArray>

Get a TimestampMicrosecond column by name.

pub fn slice(&self, offset: usize, length: usize) -> Self

Zero-copy slice of the DataTable.

pub fn inner(&self) -> &RecordBatch

Borrow the inner RecordBatch.

pub fn into_inner(self) -> RecordBatch

Consume and return the inner RecordBatch.

pub fn is_empty(&self) -> bool

Check if the table is empty.

Trait Implementations

impl Clone for DataTable

fn clone(&self) -> DataTable

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DataTable

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

Formats the value using the given formatter.

impl Display for DataTable

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

Formats the value using the given formatter.

impl PartialEq for DataTable

fn eq(&self, other: &Self) -> 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.