Developer Documentation¶

Tags contributor

Documentation for contributors and developers working on BenchBox.

Roadmap¶

Development Roadmap - Planned platform and benchmark additions

Getting Started with Development¶

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

Contributing¶

Adding New Platforms - How to add support for new database platforms
Import Patterns - Lazy loading and dependency management patterns
TPC Compilation Guide - Compiling TPC benchmark tools

Architecture & Design¶

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 run execution/export branches
Data Sharing - Data sharing between benchmark phases
Dependency Compatibility - Managing optional dependencies

Testing¶

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

Reference¶

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