Skip to content

index.md

Latest commit

 

History

History
92 lines (66 loc) · 3.82 KB

index.md

File metadata and controls

92 lines (66 loc) · 3.82 KB
Raw

Design & Architecture

How BenchBox works internally.

Contents

Architecture Design

System components and design patterns.

Project Structure

Code organization and directories.

Future State Proposals

End-state extraction and refactoring targets tied to active planning TODOs.

Design Principles

Self-contained - No external dependencies.

Modular - Easy to extend and maintain.

Fast - Built for performance.

Cross-database - Works with any SQL database.

Architecture Overview

┌─────────────────────────────────────────────────────────────┐
│                    BenchBox Architecture                    │
├─────────────────────────────────────────────────────────────┤
│  User Interface Layer                                       │
│  ┌─────────────┐ ┌─────────────┐ ┌─────────────┐           │
│  │    TPCH     │ │   TPCDS     │ │ JoinOrder   │    ...    │
│  └─────────────┘ └─────────────┘ └─────────────┘           │
├─────────────────────────────────────────────────────────────┤
│  Core Framework Layer                                       │
│  ┌─────────────┐ ┌─────────────┐ ┌─────────────┐           │
│  │ BaseBench   │ │ QueryMgr    │ │ DataGen     │           │
│  └─────────────┘ └─────────────┘ └─────────────┘           │
├─────────────────────────────────────────────────────────────┤
│  Infrastructure Layer                                       │
│  ┌─────────────┐ ┌─────────────┐ ┌─────────────┐           │
│  │ SQL Trans   │ │   Caching   │ │ File I/O    │           │
│  └─────────────┘ └─────────────┘ └─────────────┘           │
└─────────────────────────────────────────────────────────────┘

Component Overview

Core Framework

  • BaseBenchmark - Base class for all benchmarks
  • QueryManager - SQL query storage
  • DataGenerator - Data generation
  • Schema - Database schemas

Benchmarks

  • TPC-H, TPC-DS, Join Order, Primitives
  • Custom benchmark support

Infrastructure

  • SQL Translation - Cross-dialect support
  • Caching - Performance optimization
  • File I/O - Data management

Design Patterns

Strategy Pattern - Different data generation algorithms.

Factory Pattern - Consistent benchmark creation.

Template Method - Standardized execution workflow.

Getting Started

  1. Read Architecture Design
  2. Review Project Structure
:maxdepth: 1
:caption: Design Docs
:hidden:

architecture
structure
future-state/index