API Reference
This page lists the benchmark classes and the import path to use for each. For detailed API documentation, see Python API Reference.
Each benchmark class takes scale_factor and output_dir and inherits from BaseBenchmark; see Base Benchmark API for the methods they share. The canonical import is the one exported from the top-level benchbox package. The module import in the third column returns the same object.
| Benchmark | Canonical import | Module import | Contract |
|---|---|---|---|
| AMPLab Big Data | from benchbox import AMPLab | from benchbox.amplab import AMPLab | AMPLab Big Data Benchmark API |
| Base class | from benchbox import BaseBenchmark | from benchbox.base import BaseBenchmark | Base Benchmark API |
| ClickBench | from benchbox import ClickBench | from benchbox.clickbench import ClickBench | ClickBench Benchmark API |
| CoffeeShop | from benchbox import CoffeeShop | from benchbox.coffeeshop import CoffeeShop | CoffeeShop Benchmark API |
| Data Vault | from benchbox import DataVault | from benchbox.datavault import DataVault | Data Vault Benchmark API |
| Flight Data | from benchbox import FlightData | from benchbox.flightdata import FlightData | FlightData Benchmark API |
| H2O.ai database benchmark | from benchbox import H2ODB | from benchbox.h2odb import H2ODB | H2O.ai Database Benchmark API |
| Join Order | from benchbox import JoinOrder | from benchbox.joinorder import JoinOrder | Join Order Benchmark API |
| Metadata Primitives | from benchbox import MetadataPrimitives | from benchbox.metadata_primitives import MetadataPrimitives | MetadataPrimitives Benchmark API |
| NYC Taxi | from benchbox import NYCTaxi | from benchbox.nyctaxi import NYCTaxi | NYCTaxi Benchmark API |
| Read Primitives | from benchbox import ReadPrimitives | from benchbox.read_primitives import ReadPrimitives | Read Primitives Benchmark API |
| Star Schema Benchmark | from benchbox import SSB | from benchbox.ssb import SSB | SSB (Star Schema Benchmark) API |
| TPC-DI | from benchbox import TPCDI | from benchbox.tpcdi import TPCDI | TPC-DI Benchmark API |
| TPC-DS | from benchbox import TPCDS | from benchbox.tpcds import TPCDS | TPC-DS Benchmark API |
| TPC-DS One Big Table | from benchbox import TPCDSOBT | from benchbox.tpcds_obt import TPCDSOBT | TPCDSOBT Benchmark API |
| TPC-H | from benchbox import TPCH | from benchbox.tpch import TPCH | TPC-H Benchmark API |
| TPC-Havoc | from benchbox import TPCHavoc | from benchbox.tpchavoc import TPCHavoc | TPC-Havoc API |
| TPC-H Skew | from benchbox import TPCHSkew | from benchbox.tpch_skew import TPCHSkew | TPC-H Skew API |
| Transaction Primitives | from benchbox import TransactionPrimitives | from benchbox.transaction_primitives import TransactionPrimitives | Transaction Primitives API |
| TSBS DevOps | from benchbox import TSBSDevOps | from benchbox.tsbs_devops import TSBSDevOps | TSBS DevOps API |
| Vector Search | from benchbox import VectorSearch | from benchbox.vector_search import VectorSearch | Vector Search API |
| Write Primitives | from benchbox import WritePrimitives | from benchbox.write_primitives import WritePrimitives | Write Primitives Benchmark API |
TPC-DI needs the tpcdi extra (pip install "benchbox[tpcdi]").