Your daily reference for using BenchBox. This section covers configuration, running benchmarks, and understanding results.
| Task | Guide |
|---|---|
| Configure BenchBox | Configuration |
| Generate test data | Data Generation |
| Preview before running | Dry Run |
| Find example scripts | Examples Directory |
| Understand your results | Understanding Results |
| Fix common issues | Troubleshooting |
- Configuration Guide - YAML layouts, environment overrides, and precedence rules
- Intelligent Guidance - How the CLI adapts to your hardware profile
- Data Generation - Generating benchmark datasets at various scales
- Dry Run - Preview queries and configuration without executing
- Dialect Translation - SQL dialect translation vs platform adapters
- Cloud Sorted Ingestion - Opt-in deep sorting strategy for cloud DW comparisons
- TPC Logical Tuning Profiles - Tuned-template profile coverage and comparison semantics
- Databricks Liquid Clustering - Strategy control and migration from Z-ORDER
- Examples Directory - 40+ runnable examples organized by difficulty
- Code Snippets - Inline Python and shell examples
- Example Scripts - Categorized example scripts
- FAQ - Frequently asked questions
- Troubleshooting - Common issues and solutions
Core concepts for understanding BenchBox:
- Concepts Overview - Architecture, workflow, and terminology
- Glossary - Terms and definitions
- Data Model - Data structures and relationships
- Run
benchbox profileto capture a baseline system profile - Pick a platform with
benchbox platforms list - Execute a benchmark:
benchbox run --platform duckdb --benchmark tpch --scale 0.01 - View results:
benchbox results --limit 1
- Getting Started - First-time setup
- CLI Reference - Complete command documentation
- Guides - Task-oriented how-to guides
:maxdepth: 1
installation
getting-started
cli-quick-start
configuration
examples
examples-directory
examples/index
dry-run
data-generation
dialect-translation
cloud-sorted-ingestion
tpc-tuning-profiles
databricks-liquid-clustering
intelligent-guidance
faq
troubleshooting
README