Skip to content

BenchBox 0.1.0 documentation

BenchBox 0.1.0 documentation

Getting Started

BenchBox Documentation
Installation & Environment Setup
Getting Started in 5 Minutes
BenchBox CLI – Quick Reference
MCP Integration Guide
Tutorials
Your First Benchmark

User Guide

User Guide
Configuration Handbook
Data Generation
Dry Run Mode
Examples Directory Guide
Understanding Benchmark Results
Troubleshooting Guide
Frequently Asked Questions (FAQ)
Concepts

Benchmarks

Benchmarks
TPC Standards
Industry Benchmarks
BenchBox Primitives
BenchBox Experimental
Potential Future Benchmarks

Platforms

Platform Documentation
Platform Selection Guide
Multi-Platform Database Support
Platform Comparison Matrix
SQL Platforms
DataFrame Platforms
Cloud Platforms
Potential Future Platforms

Guides

Guides
TPC Benchmark Guides
Advanced Topics
Open Table Formats Guide
Advanced Performance Optimization Guide
Power Run Iterations and Concurrent Query Execution
Optimizer Sniff Test Queries
CI/CD Integration Guide
Custom Benchmarks
BenchBox Visualization Architecture
Cloud Storage Support
Data Compression in BenchBox

Reference

Reference Documentation
BenchBox CLI Reference
Python API Reference
MCP Server Reference
Benchmark Result Schema (v1.1)
API Reference

Development

Developer Documentation
Getting Started with Development
Architecture & Design
Platform Development
BenchBox Architecture Design Document
Testing Documentation
- End-to-End (E2E) Testing Guide
- Live Integration Tests

Browse by Tag

Browse by Tag

Architecture & Design¶

Tags contributor concept

Deep-dive into BenchBox’s architecture, design patterns, and code structure.

Design & Architecture
BenchBox Architecture Design Document
BenchBox Repository Structure
Import Patterns and Lazy Loading

Design & Architecture

DB API 2.0: Foundation of BenchBox Platform Support

Copyright © 2025, Joe Harris

Made with Sphinx and @pradyunsg's Furo