Reference Documentation

Complete reference documentation for BenchBox APIs, CLI, and data formats.

Command Line Interface

• CLI Reference - Complete command-line interface documentation
  • run - Primary benchmark execution command
  • convert - Convert data to Parquet, Vortex, Delta Lake, or Iceberg
  • shell - Interactive SQL shell
  • platforms - Platform management
  • results - Export, view, and compare results
  • tuning - Tuning configuration commands
  • utilities - Utility commands

Python API

• API Reference - Python API overview
• Python API Documentation - Detailed API reference (Sphinx)
• Public Contracts and Support Taxonomy - Compatibility tiers, support status vocabulary, and source-of-truth map

Integrations

• MCP Server Reference - Model Context Protocol server for AI assistants

Data Formats & Schemas

• Result Export Formats - Comprehensive guide to JSON, CSV, HTML exports
• Result Schema v1.0 - Benchmark result JSON schema specification
• Backward Compatibility Registry - Lifecycle policy and shim tracking process

Related Documentation

• Usage Guides - Practical usage examples
• How-To Guides - Task-oriented guides
• Platform Documentation - Platform-specific reference

• BenchBox CLI Reference
  • Global Options
  • Commands Overview
  • Quick Start
  • Documentation Sections
• CLI Command Reference
  • BenchBox CLI Reference
  • run - Run Benchmarks
  • shell - Interactive SQL Shell
  • platforms - Platform Management
  • Tuning Commands
  • Results Commands
  • Configuration
  • Utility Commands
  • Common Workflows
  • Troubleshooting
• API Reference
  • Core Classes
  • Benchmark Classes
  • Configuration
  • Database Integration
  • Common Patterns
  • See Also
• Public Contracts and Support Taxonomy
  • Contract Tiers
  • Public Surface Map
  • Support Status Taxonomy
  • Benchmark Visibility Policy
  • Count and Drift Policy
  • Visualization Chart Contract
  • SQL/DataFrame Result Bundle Invariants
  • Result Model Extension Policy
  • Translation and Validation Mode Policy
• MCP Server Reference
  • Running the Server
  • Tools
  • Prompts
  • Resources
  • Error Handling
  • Related Documentation
• Result Export Formats
  • Export Commands
  • JSON Format (Schema v2)
  • CSV Format
  • HTML Format
  • Visualizing Results
  • Loading Results in Python
  • Visualization Examples
  • Schema Versioning
  • Anonymization
  • Integration Examples
  • Related Documentation
• Benchmark Result Schema (v1.1, Legacy)
  • Top-Level Structure
  • Results Payload
  • Export Block
  • Validation
  • Compatibility Notes
• Backward Compatibility Registry
  • Release Stage Policy
  • Scope
  • Lifecycle States
  • Current Inventory
  • Removed Compatibility Surfaces
• Python API Reference
  • Overview
  • Quick Start
  • API Organization
  • Common Patterns
  • Type Hints
  • Configuration Classes
  • See Also
• Platform API Reference
  • Common platform adapter API
  • DuckDB Platform Adapter
  • Apache DataFusion Platform Adapter
  • ClickHouse Platform Adapter
  • Databricks Platform Adapter
  • BigQuery Platform Adapter
  • Snowflake Platform Adapter
  • Amazon Redshift Platform Adapter
  • SQLite Platform Adapter
  • Polars Platform Adapter
  • benchbox.platforms