BenchBox helps you run industry benchmarks across analytical databases. The documentation is organized to get you productive quickly and keep deeper references tidy.
- Getting started in 5 minutes, install, run your first benchmark, and inspect the output.
- CLI quick reference, command overview and the most useful flags.
- Choose a platform, requirements and trade-offs for each adapter.
- Installation & environment setup, uv, pip, extras, and dependency checks.
BenchBox adopts Semantic Versioning (MAJOR.MINOR.PATCH) to communicate compatibility expectations:
- Increase MAJOR for breaking CLI, configuration, or API changes.
- Increase MINOR for backward-compatible feature additions.
- Increase PATCH for bug fixes or documentation-only updates.
Current release: v0.2.1. Use benchbox --version for a human-readable summary or benchbox --version-json when you need structured diagnostics in automation. Both commands confirm that the package, pyproject.toml, and documentation markers stay aligned. Platform runs now capture the requested versus resolved driver package versions, so comparisons across DuckDB or connector releases remain reproducible.
- Usage overview, end-to-end workflows and tips.
- Configuration handbook, CLI flags, config files, and validation.
- Examples, curated snippets for automation.
- API reference, programmatic access points.
- Benchmark catalog, supported suites and feature matrix.
- Platform comparison, latency, scale, and capability notes.
- Data generation and compression, storage guidance and tuning.
- Power-run and throughput testing.
- Optimizer and validation tooling.
- Performance monitoring and regression alerts.
- Custom benchmark authoring.
- Architecture & design notes.
- Development workflow and platform onboarding guide.
- Check the root
CONTRIBUTING.mdfor contribution expectations and coding standards.
- Frequently Asked Questions (FAQ) answers common questions about BenchBox.
- Troubleshooting guide covers common errors and remediation steps.
- Open issues or discussions on GitHub if you get stuck.