Struct BatchGeneratorBuilder

pub struct BatchGeneratorBuilder { /* private fields */ }

A builder to create a record batch reader with generated data

This type is meant to be used in a fluent builder style to define the schema and generators for a record batch reader.

Implementations

impl BatchGeneratorBuilder

pub fn new() -> Self

Create a new BatchGeneratorBuilder with a default random seed

pub fn new_with_seed(seed: Seed) -> Self

Create a new BatchGeneratorBuilder with the given seed

pub fn col(self, name: impl Into<String>, gen: Box<dyn ArrayGenerator>) -> Self

Adds a new column to the generator

See crate::generator::array for methods to create generators

pub fn anon_col(self, gen: Box<dyn ArrayGenerator>) -> Self

Adds a new column to the generator with a generated unique name

See crate::generator::array for methods to create generators

pub fn into_batch_rows( self, batch_size: RowCount, ) -> Result<RecordBatch, ArrowError>

pub fn into_batch_bytes( self, batch_size: ByteCount, rounding: RoundingBehavior, ) -> Result<RecordBatch, ArrowError>

pub fn into_reader_rows( self, batch_size: RowCount, num_batches: BatchCount, ) -> impl RecordBatchReader

Create a RecordBatchReader that generates batches of the given size (in rows)

pub fn into_reader_stream( self, batch_size: RowCount, num_batches: BatchCount, ) -> BoxStream<'static, Result<RecordBatch, ArrowError>>

pub fn into_reader_bytes( self, batch_size_bytes: ByteCount, num_batches: BatchCount, rounding: RoundingBehavior, ) -> Result<impl RecordBatchReader, ArrowError>

Create a RecordBatchReader that generates batches of the given size (in bytes)

pub fn with_seed(self, seed: Seed) -> Self

Set the seed for the generator

pub fn with_random_nulls(&mut self, default_null_probability: f64)

Adds nulls (with the given probability) to all columns

Trait Implementations

impl Default for BatchGeneratorBuilder

fn default() -> BatchGeneratorBuilder

Returns the “default value” for a type.