Skip to main content

RowBatch

Struct RowBatch 

Source
pub struct RowBatch {
    pub column_names: Arc<[Arc<str>]>,
    pub column_types: Arc<[DataTypeNode]>,
    pub column_data: Vec<Vec<Value>>,
    pub num_rows: usize,
}
Available on crate feature sea-ql only.
Expand description

A column-oriented batch of dynamically-typed rows.

Instead of one sea_query::Value vector per row (as in DataRow), RowBatch stores one Vec<Value> per column. This layout is efficient for columnar processing and is the natural precursor to Apache Arrow record batches.

All column_data vectors have exactly num_rows entries.

Obtain batches via crate::query::DataRowCursor::next_batch.

§Example

let mut cursor = client
    .query("SELECT number, toString(number) AS s FROM system.numbers LIMIT 100")
    .fetch_rows()?;

while let Some(batch) = cursor.next_batch(32).await? {
    println!("{} rows, {} columns", batch.num_rows, batch.column_names.len());
    for (name, col) in batch.column_names.iter().zip(&batch.column_data) {
        println!("  {name}: {} values", col.len());
    }
}

Fields§

§column_names: Arc<[Arc<str>]>

Column names in schema order, shared with all other batches from the same query.

§column_types: Arc<[DataTypeNode]>

ClickHouse data types in schema order, shared with all other batches from the same query.

§column_data: Vec<Vec<Value>>

Per-column value vectors; column_data[i] holds all values for column_names[i].

Every inner Vec has exactly num_rows entries.

§num_rows: usize

Number of rows in this batch.

Trait Implementations§

Source§

impl Clone for RowBatch

Source§

fn clone(&self) -> RowBatch

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RowBatch

Source§

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

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

impl PartialEq for RowBatch

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl StructuralPartialEq for RowBatch

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<U> As for U

Source§

fn as_<T>(self) -> T
where T: CastFrom<U>,

Casts self to type T. The semantics of numeric casting with the as operator are followed, so <T as As>::as_::<U> can be used in the same way as T as U for numeric conversions. 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Is for T
where T: ?Sized,

Source§

type EqTo = T

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

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