TpchGenerator

Struct TpchGenerator 

Source
pub struct TpchGenerator { /* private fields */ }
Expand description

TPC-H data generator

The main entry point for generating TPC-H benchmark data. Use the builder pattern via TpchGenerator::builder() to configure and create instances.

§Examples

use tpchgen_cli::{TpchGenerator, Table, OutputFormat};
use std::path::PathBuf;
use ::parquet::basic::ZstdLevel;
// Generate all tables at scale factor 1 in TBL format
TpchGenerator::builder()
    .with_scale_factor(1.0)
    .with_output_dir(PathBuf::from("./data"))
    .build()
    .generate()
    .await?;

// Generate specific tables in Parquet format with compression
TpchGenerator::builder()
    .with_scale_factor(10.0)
    .with_output_dir(PathBuf::from("./benchmark_data"))
    .with_tables(vec![Table::Orders, Table::Lineitem])
    .with_format(OutputFormat::Parquet)
    .with_parquet_compression(tpchgen_cli::Compression::ZSTD(ZstdLevel::try_new(1).unwrap()))
    .with_num_threads(16)
    .build()
    .generate()
    .await?;

Implementations§

Source§

impl TpchGenerator

Source

pub fn builder() -> TpchGeneratorBuilder

Create a new builder for configuring the generator

This is the recommended way to construct a TpchGenerator.

§Examples
use tpchgen_cli::TpchGenerator;

let generator = TpchGenerator::builder()
    .with_scale_factor(1.0)
    .build();
Source

pub async fn generate(self) -> Result<()>

Generate TPC-H data with the configured settings

This async method performs the actual data generation, creating files in the configured output directory (or writing to stdout if configured).

§Returns
  • Ok(()) on successful generation
  • Err(io::Error) if file I/O or generation fails
§Examples
use tpchgen_cli::TpchGenerator;

TpchGenerator::builder()
    .with_scale_factor(1.0)
    .build()
    .generate()
    .await?;

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<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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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, 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> Allocation for T
where T: RefUnwindSafe + Send + Sync,