Documentation for contributors and developers working on BenchBox.
- Development Roadmap - Planned platform and benchmark additions
- Development Guide - Setting up development environment and workflow
- Testing - Testing strategies, running tests, and test organization
- Pytest xdist Safety - Why macOS worker counts are capped and how to validate changes
- Adding New Platforms - How to add support for new database platforms
- New Platform Acceptance Checklist - Required registry, docs, tests, compatibility, and UAT gates
- Import Patterns - Lazy loading and dependency management patterns
- TPC Compilation Guide - Compiling TPC benchmark tools
- Architecture Overview - High-level system architecture
- Code Structure - Codebase organization
- DB API 2.0 - Python DB API 2.0 specification and platform integration
- Runtime Modules - Runtime module organization and responsibilities
- Run Lifecycle Map - Current
benchbox runexecution/export branches - Data Sharing - Data sharing between benchmark phases
- Dependency Compatibility - Managing optional dependencies
- Testing Guide - Testing strategies and test organization
- Pytest xdist Safety - Root cause, reproducer, and validation checklist for xdist lock-ups
- Testing Index - Test documentation overview
- Live Integration Tests - Running tests against live databases
- Result Execution Environment Contract - Normalized client host, platform runtime, cloud/compute/storage facets, and anonymization policy
- Result Integrity Validation - Three-tier validator: structural, completeness, and believability checks for result JSON files
- Read Primitives Catalog - Catalog of primitive read operations
- Read Primitives: Platform Skip Reference - Why each query is skipped per platform and how to re-enable
- Concepts - Core concepts and glossary
:maxdepth: 1
roadmap
getting-started
development
platform-development
adding-new-platforms
adding-dataframe-platform
new-platform-acceptance-checklist
architecture-design
data-dependencies
import-patterns
tpc-compilation-guide
testing
pytest-xdist-safety
read-primitives-catalog
read-primitives-skips-reference
runtime-modules
run-lifecycle-map
data-sharing
dependency-compatibility
db-api-2
test-quality-guidelines
result-execution-environment
result-integrity-validation
../platform-config-audit